Get project by ID or name

Retrieve a specific project using its unique identifier: either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

GET /v1/projects/{project_identifier}

Try it

Get project by ID or name

cURL

curl --request GET \
  --url https://api.example.com/v1/projects/{project_identifier}

200

{
  "data": {
    "name": "<string>",
    "id": "<string>",
    "description": "<string>"
  }
}

Path Parameters

project_identifier · string · required

The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Response

200

application/json

The requested project

data · Project · object · required

Show child attributes

data. name · string · required

Minimum string length: 1

data. id · string · required

data. description · string | null