Skip to content

List projects​

GET
/v1/projects

Returns lightweight summaries of the signed-in user's books — not the full page-by-page payload, so it stays fast even with hundreds of projects. Search, filter by status or language, sort, and page through the results with query parameters.

Authorizations​

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Responses​

OK

application/json

One page of results plus the total count, so a client can render paging controls.

The items on this page (in sort order).

The 1-based page number these items are from.

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

The page size that was applied.

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

Total matching items across all pages (after filtering, before paging).

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

Total number of pages for int PagedResult<T>.Total at this int PagedResult<T>.PageSize (≥ 1).

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

Playground​

Server
Authorization

Samples​

Powered by VitePress OpenAPI