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",
      "fullName": "DEX Belgium",
      "displayName": "DEX Belgium",
      "email": "info@dex.be",
      "phone": "+32 3 123 45 67",
      "address": "Hoofdstraat 1",
      "postalCode": "2000",
      "city": "Antwerpen",
      "province": "Antwerpen",
      "logoUrl": "https://cdn.okasie.be/logos/dex.png",
      "metadata": {},
      "parent": null,
      "isRoot": true,
      "stats": {
        "activeListings": 250,
        "totalListings": 312,
        "avgActivePrevMonth": 238.5
      },
      "updatedAt": "2024-10-05T09:12:01Z"
    }
  ],
  "meta": {
    "total": 5,
    "profileIds": ["8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f"],
    "rootProfileIds": ["8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f"],
    "filters": {
      "parentId": null,
      "search": null
    },
    "partner": {
      "id": "partner-id",
      "name": "Partner Name"
    }
  }
}

GET

api

external

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",
      "fullName": "DEX Belgium",
      "displayName": "DEX Belgium",
      "email": "info@dex.be",
      "phone": "+32 3 123 45 67",
      "address": "Hoofdstraat 1",
      "postalCode": "2000",
      "city": "Antwerpen",
      "province": "Antwerpen",
      "logoUrl": "https://cdn.okasie.be/logos/dex.png",
      "metadata": {},
      "parent": null,
      "isRoot": true,
      "stats": {
        "activeListings": 250,
        "totalListings": 312,
        "avgActivePrevMonth": 238.5
      },
      "updatedAt": "2024-10-05T09:12:01Z"
    }
  ],
  "meta": {
    "total": 5,
    "profileIds": ["8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f"],
    "rootProfileIds": ["8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f"],
    "filters": {
      "parentId": null,
      "search": null
    },
    "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. Alias: parent_id

includeChildren

boolean

default:"true"

Include child locations in the result set

withCounts

boolean

default:"true"

Include listing counts per location

string

Search by name, city, province, or location code

Response

Location Response Field Names

Field	Description
`id`	Location profile UUID
`parentId`	Parent location UUID
`isRoot`	Whether this location is in the partner root scope
`locationCode`	Unique location code
`companyName`	Company name
`fullName`	Full profile name
`displayName`	Display name
`email`	Contact email
`phone`	Contact phone
`address`	Street address
`postalCode`	Postal code
`city`	City
`province`	Province
`logoUrl`	Logo URL
`metadata`	Location metadata
`parent.id`	Parent profile UUID
`parent.locationCode`	Parent location code
`parent.companyName`	Parent company name
`parent.fullName`	Parent full name
`parent.displayName`	Parent display name
`stats.activeListings`	Active listing count
`stats.totalListings`	Total listing count
`stats.avgActivePrevMonth`	Average active listings previous month, when available
`updatedAt`	ISO 8601 last update timestamp
`meta.total`	Number of returned locations
`meta.profileIds`	Effective profile IDs in response scope
`meta.rootProfileIds`	Partner root profile IDs, when available
`meta.filters.parentId`	Applied parent filter
`meta.filters.search`	Applied search filter
`meta.partner`	Partner metadata

data

array

Array of location objects

Show Location properties

string

Location profile UUID

parentId

string

Parent location UUID (null for root)

locationCode

string

Unique location code

companyName

string

Legal company name

fullName

string

Full profile name

displayName

string

Display name

string

Contact email

phone

string

Contact phone

address

string

Street address

postalCode

string

Postal code

city

string

City

province

string

Province

logoUrl

string

Logo URL

metadata

object

Location metadata

parent

object

Parent profile summary

isRoot

boolean

True if this is a root/parent location

stats

object

Listing statistics (when withCounts=true)

updatedAt

string

ISO 8601 last update timestamp

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",
      "fullName": "DEX Belgium",
      "displayName": "DEX Belgium",
      "email": "info@dex.be",
      "phone": "+32 3 123 45 67",
      "address": "Hoofdstraat 1",
      "postalCode": "2000",
      "city": "Antwerpen",
      "province": "Antwerpen",
      "logoUrl": "https://cdn.okasie.be/logos/dex.png",
      "metadata": {},
      "parent": null,
      "isRoot": true,
      "stats": {
        "activeListings": 250,
        "totalListings": 312,
        "avgActivePrevMonth": 238.5
      },
      "updatedAt": "2024-10-05T09:12:01Z"
    }
  ],
  "meta": {
    "total": 5,
    "profileIds": ["8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f"],
    "rootProfileIds": ["8f8f8f8f-8f8f-408f-a8f8-8f8f8f8f8f8f"],
    "filters": {
      "parentId": null,
      "search": null
    },
    "partner": {
      "id": "partner-id",
      "name": "Partner Name"
    }
  }
}

Error Responses

Status	Code	Description
401	`UNAUTHORIZED`	Invalid or missing API key
500	`SERVER_ERROR`	Failed to load locations

Update Listing Status Get Location Listings

​List Locations

​Query Parameters

​Response

​Location Response Field Names

​Error Responses

List Locations

Query Parameters

Response

Location Response Field Names

Error Responses