projects

[Preview] Get a project

Changed on

Retrieve a specific project by its ID.

The company must have the Tags feature enabled in their price plan.

Preview: This endpoint is in preview and may change or be removed before general availability. Read the full preview policy

Scope: projects:read

get/companies/{companyId}/projects/{projectId}

Request

  • Base URL
    https://api.bokio.se/v1
  • URL
    https://api.bokio.se/v1/companies/{companyId}/projects/{projectId}
  • Auth
    HTTP bearer

Response

Project found

idstring uuid required

Unique identifier of the project

namestring required

Name of the project

projectNumberstring required

The project number, unique per company. Used as the dimension 6 tag value.

status'active' | 'archived' required

The lifecycle status of the project

startDatestring date nullable

The date the project starts (yyyy-MM-dd)

endDatestring date nullable

The date the project ends (yyyy-MM-dd)

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Website Redesign",
  "projectNumber": "P-001",
  "status": "active",
  "startDate": "2026-01-15",
  "endDate": "2026-12-31",
  "customerRef": {
    "id": "d4e5f6a7-b8c9-0123-def1-234567890123",
    "name": "Acme AB",
    "customerNumber": "CUST-001"
  },
  "tagRef": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "P-001"
  }
}

Changes