Skip to main content
GET
Get a project by id

Authorizations

Authorization
string
header
required

Authorization code flow with PKCE-S256. RFC 8628 device flow is also supported.

Path Parameters

projectId
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Query Parameters

capabilities
enum<string>

Optional: live (default) checks GitHub namespace authority now. display may answer from a roster up to 70 minutes old; never use a display capability to authorize a write.

Available options:
live,
display
commitToken
string

Optional: opaque commit token from a project create, to read the project at a snapshot that contains that write.

Pattern: ^$|^[A-Za-z0-9_-]{20,512}$

Response

OK

capabilities
object
required
createdAt
string<date-time>
required
id
string
required
name
string
required
ownerId
string
required
ownerType
enum<string>
required
Available options:
org,
account
region
string
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"/api/v1/schemas/Project.json"

apiUrl
string

Public entire-api base URL for the assigned cell. Empty when unassigned or routing is unavailable; do not fall back to another cell.

ownerName
string
primaryProcessingCell
string

Stored processing cell ID, not a cluster slug. Empty when the project is unassigned.

repositoryCount
integer<int64>

Published logical repositories in paginated project listings. Omitted without project inspect permission or when unavailable.

Required range: x >= 0