Skip to content
GET /v2/projects

List projects

Returns a paginated list of projects accessible to the authenticated user. Results can be filtered by status and searched by name or repository. Items are ordered by most recently updated.

Requires authentication. Send a bearer token in the Authorization header. Tokens are scoped per workspace.

Query parameters

per_page integer optional
Number of items per page. Max 100, defaults to 20.
page integer optional
Page number to retrieve. Defaults to 1.
status string optional
Filter by documentation status: live, building, or draft.
q string optional
Full-text search across project name and repository slug.

Responses

200 OK — A paginated list of projects.
401 Unauthorized — Missing or invalid bearer token.
422 Unprocessable — An invalid query parameter was supplied.

Response schema

200 · application/json

data array<Project>
The list of projects for the authenticated account.
data[].id string
Unique project identifier, prefixed with prj_.
data[].name string
Human-readable project name.
data[].repository string
Connected repository in owner/name form.
data[].status enum
One of live, building, draft.
meta object
Pagination metadata: page, per_page, total.