Skip to main content
Retrieves a single project from the workspace. By default, the projectId path parameter is matched against the internal project ID. Set by_custom_id=true to look up the project by its custom identifier instead.
Permission required: project:read

Path Parameters

workspaceId
string
required
Workspace identifier
projectId
string
required
Project identifier. Interpreted as the internal ID by default, or as the custom ID when by_custom_id is true.

Query Parameters

by_custom_id
boolean
When true, the projectId path parameter is matched against the project’s custom_id instead of its internal id.

Response

data
object