List apps
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)
Authorizations
Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:
Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key.
Security best practices:
- Keep root keys secure and never expose them in client-side code
- Use different root keys for different environments
- Rotate keys periodically, especially after team member departures
- Create keys with minimal necessary permissions following least privilege principle
- Monitor key usage with audit logs.
Body
Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.
3 - 255^[a-zA-Z0-9_-]+$"proj_1234abcd"
Maximum number of apps to return per request. Balance between response size and number of pagination calls needed.
1 <= x <= 100Pagination cursor from a previous response to fetch the next page.
Use when hasMore: true in the previous response.
"app_1234abcd"
Free-form text to filter apps. Returns apps whose ID, name, or slug contains the search string. Matching is case-insensitive.
256"checkout"
Response
Successfully retrieved a paginated list of apps. Use the pagination cursor for additional results when hasMore: true.
Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.
Array of apps in the project, ordered by app id.
100Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.