UNunkeyed
projects

List projects

Changed on

Retrieve a paginated list of projects in your workspace.

Use this to build project management dashboards or to enumerate projects for administrative purposes. Results are ordered by project id and returned in pages. When hasMore is true, pass the returned cursor to fetch the next page.

Required Permissions

Your root key must have the following permission:

  • project.*.read_project (to read projects in your workspace)
post/v2/projects.listProjects

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/projects.listProjects
  • Auth
    HTTP bearer

Request body

limitinteger

Maximum number of projects 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 projects. Returns projects whose ID, name, or slug contains the search string. Matching is case-insensitive.

Example request

{
  "cursor": "proj_1234abcd",
  "search": "billing-service"
}

Response

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

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "id": "proj_1234abcd",
      "name": "Payments Service",
      "slug": "payments-service",
      "createdAt": 1704067200000,
      "updatedAt": 1704153600000
    }
  ],
  "pagination": {
    "cursor": "eyJrZXkiOiJrZXlfMTIzNCIsInRzIjoxNjk5Mzc4ODAwfQ==",
    "hasMore": true
  }
}

Changes