Company

You can use the endpoint below to fetch information about the company you're using, its subsidiaries, available add-ons, and more.

Get company information

get

Get information about the company associated with the provided API key

Header parameters

x-api-tokenstringRequired

Company API key

Responses

200

Company info returned

application/json

or

401

UNAUTHORIZED

application/json

get/api/v3/me

HTTPcURLJavaScriptPython

GET /api/v3/me HTTP/1.1
x-api-token: text
Accept: */*

{
  "id": "kdj49fkf0fkkn",
  "name": "Acme Corporation",
  "orgNumber": "123456789",
  "address": "Skippergata 9",
  "postalCode": "0152",
  "postalPlace": "Oslo",
  "region": "no",
  "createdAt": "2024-01-01T00:00:00Z",
  "availableAddons": [
    {
      "name": "carInspection",
      "description": "Car inspection add-on",
      "productAvailability": [
        "value",
        "standard",
        "express",
        "precise"
      ]
    }
  ],
  "savedBookingInstructions": [
    {
      "text": "Enter the building at entrance 3, drop off the keys at the reception"
    }
  ],
  "savedBookingAddresses": [
    {
      "address": "Skippergata 9",
      "postalCode": "0152",
      "comment": "Main office"
    }
  ],
  "savedBookingContacts": [
    {
      "name": "John Doe",
      "phone": "[phone]"
    }
  ],
  "type": "head",
  "subsidiaries": [
    {
      "id": "kdj49fkf0fkkn",
      "name": "Acme Corporation",
      "orgNumber": "123456789",
      "address": "Skippergata 9",
      "postalCode": "0152",
      "postalPlace": "Oslo",
      "region": "no",
      "createdAt": "2024-01-01T00:00:00Z",
      "availableAddons": [
        {
          "name": "carInspection",
          "description": "Car inspection add-on",
          "productAvailability": [
            "value",
            "standard",
            "express",
            "precise"
          ]
        }
      ],
      "savedBookingInstructions": [
        {
          "text": "Enter the building at entrance 3, drop off the keys at the reception"
        }
      ],
      "savedBookingAddresses": [
        {
          "address": "Skippergata 9",
          "postalCode": "0152",
          "comment": "Main office"
        }
      ],
      "savedBookingContacts": [
        {
          "name": "John Doe",
          "phone": "[phone]"
        }
      ],
      "type": "subsidiary"
    }
  ]
}