Projects

Every endpoint on this page requires projects:read.

GET /v1/projects

Returns a paged project collection.

Query parameters

Parameter	Type	Notes
cursor	string	Optional cursor
direction	string	asc, ascending, desc, or descending
include_no_lead	boolean	Include projects with no lead
label_id	string, repeatable	Filter by label ID
lead_user_account_id	string, repeatable	Filter by lead
page_size	integer	Optional page size
priority	string, repeatable	Priority name or numeric code
sort	string	name, priority, lead, target, target_date, or status
status_id	string, repeatable	Filter by status ID
team_code	string	Optional team-code filter
team_id	string, repeatable	Optional team-id filter

Example

curl "$API_BASE_URL/v1/projects?team_code=PLAT&priority=2&sort=target_date&direction=asc" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response 200 OK:

{
  "results": [
    {
      "id": "proj_docs",
      "workspaceId": "ws_01EXAMPLE",
      "name": "Public API Docs",
      "summary": "Ship the first complete public API reference.",
      "description": "Documentation work for the public API rollout.",
      "slug": "public-api-docs",
      "key": "DOCS",
      "iconCss": "fa-regular fa-book-open",
      "color": "#0f766e",
      "state": "active",
      "statusId": "proj-status_in-progress",
      "priority": 2,
      "teamId": "team_platform",
      "leadUserAccountId": "usr_01EXAMPLE",
      "labelIds": [
        "label_docs"
      ],
      "targetUtc": "2025-03-15T00:00:00Z",
      "progressPercent": 55,
      "linkCount": 2
    }
  ],
  "pagination": {
    "pageSize": 100,
    "cursor": "",
    "nextCursor": "",
    "hasMore": false,
    "returnedCount": 1,
    "totalCount": 1
  }
}

GET /v1/projects/{projectKey}

Returns one project by project key.

curl "$API_BASE_URL/v1/projects/DOCS" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response 200 OK:

{
  "id": "proj_docs",
  "workspaceId": "ws_01EXAMPLE",
  "name": "Public API Docs",
  "slug": "public-api-docs",
  "key": "DOCS",
  "summary": "Ship the first complete public API reference.",
  "description": "Documentation work for the public API rollout.",
  "iconCss": "fa-regular fa-book-open",
  "color": "#0f766e",
  "state": "active",
  "statusId": "proj-status_in-progress",
  "priority": 2,
  "teamId": "team_platform",
  "leadUserAccountId": "usr_01EXAMPLE",
  "memberUserAccountIds": [
    "usr_01EXAMPLE",
    "usr_01SAM"
  ],
  "labelIds": [
    "label_docs"
  ],
  "startUtc": "2025-02-01T00:00:00Z",
  "targetUtc": "2025-03-15T00:00:00Z",
  "progressPercent": 55,
  "linkCount": 2
}

GET /v1/projects/{projectKey}/links

Returns a paged collection of project links.

Query parameters

Parameter	Type	Notes
cursor	string	Optional cursor
page_size	integer	Optional page size

Example

curl "$API_BASE_URL/v1/projects/DOCS/links?page_size=2" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response 200 OK:

{
  "results": [
    {
      "linkId": "plink_tracking",
      "url": "https://example.com/tracking",
      "title": "Tracking issue",
      "createdUtc": "2025-02-24T15:04:05Z",
      "createdByUserAccountId": "usr_01EXAMPLE"
    },
    {
      "linkId": "plink_specs",
      "url": "https://example.com/specs",
      "title": "Specification",
      "createdUtc": "2025-02-24T16:18:30Z",
      "createdByUserAccountId": "usr_01SAM"
    }
  ],
  "pagination": {
    "pageSize": 2,
    "cursor": "",
    "nextCursor": "",
    "hasMore": false,
    "returnedCount": 2,
    "totalCount": 2
  }
}

Error notes

• Invalid team filters return 400 invalid_request
• Unknown project keys return 404 not_found