Location

A Location is a physical site that belongs to a Company and operates under a Brand.

Retrieving Locations for a Company

Use the GET /v1/companies/{id}/locations endpoint to retrieve a paginated list of locations belonging to a company. Both pageNumber and pageSize are required query parameters.

GET https://api.caspeco.com/api/organizations/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations?pageNumber=0&pageSize=20
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

{
  "items": [
    {
      "id": "6c9d1f2a-1a2b-4c3d-9e4f-5a6b7c8d9e0f",
      "name": "Example Location",
      "address": {
        "street": "Exempelgatan 1",
        "city": "Stockholm",
        "postalCode": "111 22"
      },
      "coordinates": {
        "latitude": 59.3293,
        "longitude": 18.0686
      },
      "countryCode": "SE",
      "timeZone": "Europe/Stockholm",
      "locale": "sv-SE",
      "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "costCenters": [
        {
          "name": "Main",
          "number": "1000"
        }
      ],
      "status": "Active",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "pageNumber": 0,
  "pageSize": 20,
  "totalItems": 1,
  "totalPages": 1
}

API Reference

See the Location reference for full endpoint documentation.