Sign in
Projects

List projects

Changed on

List projects you can access. Results are paginated and exclude deleted projects by default. Use expand to include the project brief (assumptions).

get/projects

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/projects
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

sortstring

Field to sort by. Allowed fields depend on the resource.

order'asc' | 'desc'

Sort direction.

withCountboolean

Include the total number of matching items. Defaults to false.

expandProjectExpand[]

Comma list of related data to inline on projects (depth ≤ 2). Unknown key returns 400 expand_invalid.

statusstring
Example:active

Filter by status. Separate multiple values with commas (for example, active,archived).

spaceIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only projects filed under this space.

qstring

Search project names and slugs.

includeDeletedboolean

Include deleted projects.

Response

A page of projects.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching items; present only when withCount=true was requested.

truncatedboolean

Whether some matching items were omitted from the response.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e",
      "slug": "q3-feature-doc",
      "name": "Q3 Feature Doc",
      "spaceId": "txn_8f2a1c9e",
      "tags": [
        {
          "id": "txn_8f2a1c9e"
        }
      ],
      "createdBy": {
        "id": "txn_8f2a1c9e"
      },
      "assumptions": {
        "noteId": "txn_8f2a1c9e"
      }
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

  • e8c3cc0ac298Revision changes
    • info

      added the new optional query request parameter expand

    • info

      added the optional property // to the response with the status