Sign in
Management

List projects

Changed on

Returns a paginated list of projects. You can filter by exact, case-sensitive project name using the query parameter. Project names are not unique, so multiple projects can match. You can limit the number of projects returned per page and use the provided nextCursor for pagination. This endpoint requires the read:all scope.

get/management/projects

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/management/projects
  • Auth: none declared

Query parameters

querystring

A query to filter projects by exact, case-sensitive name.

Example:name:"Frimousse"
limitinteger

A limit on the number of projects to return. The limit can range between 1 and 100, and defaults to 20.

Example:20
cursorstring

A cursor used for pagination. Get the value from the nextCursor response of the previous page.

Example:eyJjcmVhdGVkQXQiOjE2NjAwMDA5ODgxMzd9

Response

Success. Returns the list of projects and the next page cursor.

nextCursorstring nullable required

Example response

{
  "data": [
    {
      "id": "683d49ed6b4d1cec5a597b13",
      "teamId": "team_123",
      "type": "dev",
      "name": "My Project",
      "createdAt": "2024-09-03T12:34:56.000Z",
      "updatedAt": "2024-09-03T12:34:56.000Z",
      "publicKey": {
        "activated": true,
        "createdAt": "2024-09-03T12:34:56.000Z",
        "value": "pk_dev_123"
      },
      "secretKey": {
        "createdAt": "2024-09-03T12:34:56.000Z",
        "value": "sk_dev_123"
      },
      "region": "earth",
      "versionCreationTimeout": false
    }
  ],
  "nextCursor": null
}

Changes