Management

Get project

Changed on

Returns a single project specified by its ID. This endpoint requires the read:all scope. If the project cannot be found, a 404 error response is returned.

get/management/projects/{projectId}

Request

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

Path parameters

projectIdstring required

ID of the project

Example:683d49ed6b4d1cec5a597b13

Response

Success. Returns the project.

idstring required
teamIdstring required
type'dev' | 'prod' required
namestring required
descriptionstring nullable required
createdAtstring date-time required
updatedAtstring date-time required
region'earth' | 'eu' | 'fedramp' required

The region where the project's data is stored and processed.

Example response

{
  "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
}

Changes

  • 48a7e340b8adRevision changes
    • info

      added the required property to the response with the status

  • 77cd6a75b2b7Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status