Get a project

Accepts either the uuid or the project key — `APOLLO` and the id identify the same project. An id from another company returns 404 rather than 403.

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

Path Parameters

Name	Type	Required	Description
`projectId`	string	Required	Project ID, or its key (APOLLO).

GETExample request

curl

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

200Example response

json

{
  "message": "Project retrieved successfully!",
  "content": {
    "project": {
      "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"
    }
  }
}

404Example response

In the console

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

Projects

/projects

Open a project from the sidebar.