GET /api/v1/apps

Lists all apps in the org with pagination. A subset of apps can be returned that match a supported filter expression or query. The results are paginated according to the limit parameter. If there are multiple pages of results, the header contains a next link. Treat the link as an opaque value (follow it, don't parse it).

Servers

Query parameters

Name Type Required Description
limit Integer No

Specifies the number of results per page

Default value: -1

filter String No

Filters apps by status, user.id, group.id, credentials.signing.kid or name expression that supports the eq operator

q String No

Searches for apps with name or label properties that starts with the q value using the startsWith operation

after String No

Specifies the pagination cursor for the next page of results. Treat this as an opaque value obtained through the next link relationship.

useOptimization Boolean No

Specifies whether to use query optimization. If you specify useOptimization=true in the request query, the response contains a subset of app instance properties.

Default value: false

expand String No

An optional parameter used for link expansion to embed more resources in the response. Only supports expand=user/{userId} and must be used with the user.id eq "{userId}" filter query for the same user. Returns the assigned Application User in the _embedded property.

includeNonDeleted Boolean No

Specifies whether to include non-active, but not deleted apps in the results

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.