List projects

The containers work is filed in — one per initiative, client, release or season.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

projects:read

Query Parameters

Name	Type	Required	Description
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/projects" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Projects retrieved successfully!",
  "content": {
    "projects": [
      {
        "id": "prj_a1b2c3",
        "key": "APOLLO",
        "name": "Apollo billing rebuild",
        "description": "Everything that has to land before invoicing moves over.",
        "color": "violet",
        "icon": null,
        "status": "ACTIVE",
        "startDate": "2026-07-01T12:00:00.000Z",
        "targetDate": "2026-12-31T12:00:00.000Z",
        "creator": {
          "employeeId": "emp_12ab",
          "name": "Sam Okafor",
          "email": null,
          "avatarUrl": null
        },
        "ticketCount": 24,
        "milestoneCount": 3,
        "goalCount": 5,
        "createdAt": "2026-06-02T10:00:00.000Z",
        "updatedAt": "2026-08-20T09:41:00.000Z"
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Projects

/projects