Skip to main content
GET
Returns the listings of the dealers your key can reach, newest change first. This includes listings those dealers created in other ways (in the Okasie dashboard or through another feed): your own listings are the ones with your externalReference and the externalProvider value you see on them. Any valid API key can call this endpoint; no write scope is needed.

Query parameters

Invalid values do not cause an error: they fall back to the default or are ignored.
integer
default:"1"
Page number, starting at 1. Also accepted as page_number. A page past the end returns an empty data array.
integer
default:"50"
Items per page, 1 to 200. Larger values are lowered to 200. Also accepted as page_size and limit.
string
default:"active"
active, pending, sold, draft, or all for every status. Any other value (also inactive) falls back to active. Listings that were deleted have status inactive and only appear with all.
string
Only listings changed at or after this moment, as an ISO 8601 date-time, for example 2026-11-01T00:00:00Z. Also accepted as updated_since. An unparseable value is ignored.
string
Only the listings of the dealer with this Dealer ID, for example OK-00148 (exact match first, then case-insensitive). Also accepted as location_code.
string
Only the listings of this dealer profile UUID. Also accepted as locationId, profileId and userId. A value that is not a UUID is ignored.
string
Only the listings of this dealer UUID and all its child locations. Also accepted as parentId and companyId. A value that is not a UUID is ignored.
A filter for a dealer outside your access returns an empty list.

Response

HTTP 200 with the rate limit headers.
object[]
The listings. Fields without a value are null.
object
page, pageSize, totalItems, totalPages.
object
partner (id, name, source, access), filters (the filters as you sent them) and profileScope (allowed, effective and filters: the dealer UUIDs the query was limited to). See Dealer access for access.

Errors

The read endpoints return a plain error body: {"error": "<message>"}.