BObokio
projects

[Preview] List projects

Changed on

Retrieve all projects for the company. Use the query parameters to filter and navigate through the results.

A project enriches a dimension 6 (Project) tag value with business semantics such as name, project number, customer and status.

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

Request

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

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page for pagination

querystring

Optional query to filter the data set with supported fields listed below and available operations.

FieldType
namestring
projectNumberstring
statusstring

Response

Projects found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "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