Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
App Builder

List Apps

List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

get/api/v2/app-builder/apps

Query parameters

limitinteger

The number of apps to return per page.

pageinteger

The page number to return.

filter[user_name]string

Filter apps by the app creator. Usually the user's email.

filter[user_uuid]string uuid

Filter apps by the app creator's UUID.

filter[name]string

Filter by app name.

filter[query]string

Filter apps by the app name or the app creator.

filter[deployed]boolean

Filter apps by whether they are published.

filter[tags]string

Filter apps by tags.

filter[favorite]boolean

Filter apps by whether you have added them to your favorites.

filter[self_service]boolean

Filter apps by whether they are enabled for self-service.

sortAppsSortField[]

The fields and direction to sort apps by.

[
  "-created_at"
]

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "tags": [
          "service:webshop-backend",
          "team:webshop"
        ]
      },
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "meta": {
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "relationships": {
        "deployment": {
          "data": {
            "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
            "type": "deployment"
          },
          "meta": {
            "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
          }
        }
      },
      "type": "appDefinitions"
    }
  ],
  "included": [
    {
      "attributes": {
        "app_version_id": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "meta": {
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "type": "deployment"
    }
  ]
}