UNunkeyed
apps

List apps

Changed on

Retrieve a paginated list of apps within a project.

Use this to enumerate every app in a project. Results are ordered by app id and paginated; when hasMore is true, pass the returned cursor to fetch the next page.

Required Permissions

Your root key must have the following permission:

  • app.*.read_app (to read apps in any project)
post/v2/apps.listApps

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/apps.listApps
  • Auth
    HTTP bearer

Request body

projectstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

limitinteger

Maximum number of apps to return per request. Balance between response size and number of pagination calls needed.

cursorstring

Pagination cursor from a previous response to fetch the next page. Use when hasMore: true in the previous response.

searchstring

Free-form text to filter apps. Returns apps whose ID, name, or slug contains the search string. Matching is case-insensitive.

Example request

{
  "project": "proj_1234abcd",
  "cursor": "app_1234abcd",
  "search": "checkout"
}

Response

Successfully retrieved a paginated list of apps. Use the pagination cursor for additional results when hasMore: true.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "id": "app_1234abcd",
      "name": "Payments API",
      "slug": "payments-api",
      "sourceType": "oci",
      "git": {
        "repository": "unkeyed/unkey",
        "defaultBranch": "main"
      },
      "oci": {
        "image": "ghcr.io/acme/api:v1.2.3"
      },
      "currentDeploymentId": "d_1234abcd",
      "createdAt": 1704067200000,
      "updatedAt": 1704153600000
    }
  ],
  "pagination": {
    "cursor": "eyJrZXkiOiJrZXlfMTIzNCIsInRzIjoxNjk5Mzc4ODAwfQ==",
    "hasMore": true
  }
}

Changes

  • 909d2961a72cRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 2dcddab7f374Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

      added the optional property // to the response with the status