BObokio
agency-companies

Get client companies

Get all client companies connected to the agency. Use the query parameters to filter and navigate through the results. Scope: agency-companies:read

get/agencies/{agencyId}/companies

Request

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

Query parameters

pageinteger

Page number

pageSizeinteger

Number of items per page

querystring

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

FieldType
namestring
organizationNumberstring

Response

Client companies found

totalItemsinteger
totalPagesinteger
currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "55c899c5-82b2-47fa-9c51-e35fc9b26443",
      "name": "Client Company AB",
      "organizationNumber": "556677-8899",
      "vatNumber": "SE556677889901",
      "companyType": "limitedCompany",
      "address": {
        "line1": "Älvsborgsvägen 10",
        "city": "Göteborg",
        "postalCode": "123 45",
        "country": "SE"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.