latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Archived Projects

Return archived projects in a workspace.

Workspace guests cannot list archived projects and receive a FORBIDDEN error. Results are paginated by cursor and limit.

get/api/v1/workspaces/{workspace_id}/projects/archived

Path parameters

workspace_idinteger required

ID of the workspace whose archived projects should be listed.

Example:123456

Query parameters

cursorstring nullable

An opaque string used as the cursor for pagination. Must be used with the same parameters from the previous request

Example:14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55

limitinteger

The number of archived workspace projects to return in a page.

Example:50

Response

Successful Response

has_moreboolean required

Whether another page of results is available.

next_cursorstring

Cursor for the next page of results.

Example response

{
  "next_cursor": "14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55",
  "workspace_projects": [
    {
      "access": {
        "configuration": {},
        "visibility": "team"
      },
      "can_assign_tasks": true,
      "color": "charcoal",
      "default_order": 1,
      "description": "Marketing launch tasks",
      "folder_id": "1234",
      "id": "6XGgm6PHrGgMpCFX",
      "is_frozen": false,
      "is_invite_only": false,
      "is_pending_default_collaborator_invites": false,
      "name": "Marketing",
      "public_access": false,
      "public_key": "ab12cd34ef56",
      "role": "ADMIN",
      "status": "in_progress",
      "view_style": "list"
    }
  ]
}