Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Projects

Get Project

Fetches the details of the given project.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Project Owner
  • Project Manager
  • Project Viewer
  • Database Data Reader/Writer
  • Database Data Reader

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/projects/{projectId}

Response

Successfully fetched the project based on the projectId.

idstring uuid required

A GUID4 identifier of the project.

descriptionstring required

The description of a particular project.

namestring required

The name of the project.

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000",
  "description": "The description of my awesome project",
  "name": "My-Awesome-Project",
  "audit": {
    "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "createdAt": "2021-09-01T12:34:56Z",
    "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
    "modifiedAt": "2021-09-01T12:34:56Z",
    "version": 1
  }
}