Skip to main content
GET
/
api
/
external
/
v1
/
locations
curl -X GET "https://www.okasie.be/api/external/v1/locations?withCounts=true" \
  -H "Authorization: Bearer YOUR_API_SECRET"
{
  "data": [
    {
      "id": "8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f",
      "parentId": null,
      "locationCode": "DEX-HQ",
      "companyName": "DEX Belgium NV",
      "displayName": "DEX Belgium",
      "email": "[email protected]",
      "phone": "+32 3 123 45 67",
      "address": "Hoofdstraat 1",
      "postalCode": "2000",
      "city": "Antwerpen",
      "province": "Antwerpen",
      "isRoot": true,
      "stats": {
        "activeListings": 250,
        "totalListings": 312
      },
      "children": [
        {
          "id": "7f7f7f7f-7f7f-407f-a7f7-7f7f7f7f7f7f",
          "parentId": "8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f",
          "locationCode": "DEX-GENT",
          "companyName": "DEX Gent",
          "displayName": "DEX Gent",
          "city": "Gent",
          "stats": {
            "activeListings": 45,
            "totalListings": 52
          }
        }
      ]
    }
  ],
  "meta": {
    "total": 5,
    "partner": {
      "id": "partner-id",
      "name": "Partner Name"
    }
  }
}

List Locations

Retrieve dealer locations within your partner access scope. Supports hierarchical queries and optional listing counts.

Query Parameters

parentId
string
Filter to locations under this parent profile UUID
includeChildren
boolean
default:"true"
Include child locations in results
withCounts
boolean
default:"true"
Include listing counts per location
Search by name, city, province, or location code

Response

data
array
Array of location objects
meta
object
Request metadata including partner info
curl -X GET "https://www.okasie.be/api/external/v1/locations?withCounts=true" \
  -H "Authorization: Bearer YOUR_API_SECRET"
{
  "data": [
    {
      "id": "8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f",
      "parentId": null,
      "locationCode": "DEX-HQ",
      "companyName": "DEX Belgium NV",
      "displayName": "DEX Belgium",
      "email": "[email protected]",
      "phone": "+32 3 123 45 67",
      "address": "Hoofdstraat 1",
      "postalCode": "2000",
      "city": "Antwerpen",
      "province": "Antwerpen",
      "isRoot": true,
      "stats": {
        "activeListings": 250,
        "totalListings": 312
      },
      "children": [
        {
          "id": "7f7f7f7f-7f7f-407f-a7f7-7f7f7f7f7f7f",
          "parentId": "8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f",
          "locationCode": "DEX-GENT",
          "companyName": "DEX Gent",
          "displayName": "DEX Gent",
          "city": "Gent",
          "stats": {
            "activeListings": 45,
            "totalListings": 52
          }
        }
      ]
    }
  ],
  "meta": {
    "total": 5,
    "partner": {
      "id": "partner-id",
      "name": "Partner Name"
    }
  }
}

Error Responses

StatusCodeDescription
401UNAUTHORIZEDInvalid or missing API key
500SERVER_ERRORFailed to load locations