v1

latestOpenAPI 3.0.32026-07-268955212.1 KB

customers

Get customers

Get all customers for the company. Use the query parameters to filter and navigate through the results. Scope: customers:read

get/companies/{companyId}/customers

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.

Field	Type
name	string
type	string
vatNumber	string
orgNumber	string
modifiedDateTime	date-time

Response

Customers found

totalItemsinteger

totalPagesinteger

currentPageinteger

Example response

{
  "totalItems": 1,
  "totalPages": 1,
  "currentPage": 1,
  "items": [
    {
      "id": "55c899c5-82b2-47fa-9c51-e35fc9b26443",
      "name": "customer 1",
      "type": "company",
      "vatNumber": "SE1234567890",
      "orgNumber": "123456-7890",
      "paymentTerms": "30",
      "contactsDetails": [
        {
          "name": "John Doe",
          "email": "john@email.com",
          "phone": "0927-5631505",
          "isDefault": true
        }
      ],
      "address": {
        "line1": "Älvsborgsvägen 10",
        "line2": null,
        "city": "Göteborg",
        "postalCode": "123 45",
        "country": "SE"
      },
      "language": "sv",
      "modifiedDateTime": "2024-10-10T00:00:00Z"
    }
  ]
}