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_pageinteger optional - Number of items per page. Max 100, defaults to 20.
-
pageinteger optional - Page number to retrieve. Defaults to 1.
-
statusstring optional - Filter by documentation status: live, building, or draft.
-
qstring 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
-
dataarray<Project> - The list of projects for the authenticated account.
-
data[].idstring - Unique project identifier, prefixed with prj_.
-
data[].namestring - Human-readable project name.
-
data[].repositorystring - Connected repository in owner/name form.
-
data[].statusenum - One of live, building, draft.
-
metaobject - Pagination metadata: page, per_page, total.