API REFERENCE
Search accessible active/deleted businesses
GET
/api/v1/businessesList businesses accessible to the signed-in administrator. Apply supported record_status and q filters to active or retained deleted businesses. Other businesses are not discoverable.
Authentication
Requires an authorized administrator bearer session; business membership rules apply. Do not assume an integration key can replace an account session.
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
record_status | query | active | deleted | all | Active excludes soft-deleted records. Deleted and All provide authorized read-only retained history; they never restore access or planning eligibility.Default: "active" |
q | query | string | Search authorized records together with the selected record status. |
Request
No JSON request body is required.
Example request
Replace synthetic identifiers and credentials. Example dates, coordinates, revisions, and IDs are not production defaults. Read the workflow guide before making a write.
curl --request GET 'https://route-api.okok.space/api/v1/businesses' \
--header 'Authorization: Bearer REPLACE_WITH_TOKEN'Responses
Examples illustrate the documented shape; optional fields and current state can differ. JSON extraction/body-limit errors may be plain text.
200 · Only authorized retained memberships/businesses; deleted businesses are read-only.
application/json
| Field | Type | Description & constraints |
|---|---|---|
itemsRequired | array<object> | Records visible in the authorized context. |
items[] fields
| Field | Type | Description & constraints |
|---|---|---|
items.idRequired | string | Identifier unique within its authorized business. Some create operations generate it when omitted.Format: uuid |
items.nameRequired | string | Human-readable name shown in the workspace. |
items.time_zoneRequired | string | Named IANA time zone, validated by the backend. |
items.deleted_at | string | null | System-managed UTC soft-deletion instant; null for active records.Format: date-time |
items.deleted_by | string | null | Deletion actor retained for history.Format: uuid |
Illustrative response
{
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"name": "Example Services",
"time_zone": "Europe/Warsaw",
"deleted_at": "2026-11-02T09:00:00Z",
"deleted_by": "11111111-1111-4111-8111-111111111111"
}
]
}Response schema
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Business"
}
}
}
}401 · Missing/invalid/revoked token
application/json
| Field | Type | Description & constraints |
|---|---|---|
errorRequired | object | Resource-specific value; see the related workflow and schema. |
error fields
| Field | Type | Description & constraints |
|---|---|---|
error.codeRequired | validation | unauthorized | not_found | conflict | unavailable | rate_limited | Private activation or recovery code supplied to the driver. |
error.messageRequired | string | Resource-specific value; see the related workflow and schema. |
Illustrative response
{
"error": {
"code": "unauthorized",
"message": "Missing/invalid/revoked token"
}
}Response schema
{
"$ref": "#/components/schemas/Error"
}