route.

API REFERENCE

Read signed-in account and businesses

GET/api/v1/auth/me

Return the signed-in administrator profile and businesses they can access. Requires an administrator session; integration keys and driver sessions are not account sessions.

Authentication

Requires an authorized administrator bearer session; business membership rules apply. Do not assume an integration key can replace an account session.

Parameters

No path or query parameters.

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/auth/me' \
  --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 · Successful response.

application/json

FieldTypeDescription & constraints
userRequiredobjectResource-specific value; see the related workflow and schema.
businessesRequiredarray<object>Resource-specific value; see the related workflow and schema.
user fields
FieldTypeDescription & constraints
user.idRequiredstringIdentifier unique within its authorized business. Some create operations generate it when omitted.Format: uuid
user.emailRequiredstringAccount email address.Format: email
user.display_nameRequiredstringResource-specific value; see the related workflow and schema.
businesses[] fields
FieldTypeDescription & constraints
businesses.idRequiredstringIdentifier unique within its authorized business. Some create operations generate it when omitted.Format: uuid
businesses.nameRequiredstringHuman-readable name shown in the workspace.
businesses.time_zoneRequiredstringNamed IANA time zone, validated by the backend.
businesses.deleted_atstring | nullSystem-managed UTC soft-deletion instant; null for active records.Format: date-time
businesses.deleted_bystring | nullDeletion actor retained for history.Format: uuid
Illustrative response
{
  "user": {
    "id": "11111111-1111-4111-8111-111111111111",
    "email": "dispatcher@example.com",
    "display_name": "Alex"
  },
  "businesses": [
    {
      "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
{
  "$ref": "#/components/schemas/Account"
}

401 · Invalid credentials, missing bearer token, or expired/unverified session.

application/json

FieldTypeDescription & constraints
errorRequiredobjectResource-specific value; see the related workflow and schema.
error fields
FieldTypeDescription & constraints
error.codeRequiredvalidation | unauthorized | not_found | conflict | unavailable | rate_limitedPrivate activation or recovery code supplied to the driver.
error.messageRequiredstringResource-specific value; see the related workflow and schema.
Illustrative response
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid credentials, missing bearer token, or expired/unverified session."
  }
}
Response schema
{
  "$ref": "#/components/schemas/Error"
}

503 · Required persistence or credential operation unavailable.

application/json

FieldTypeDescription & constraints
errorRequiredobjectResource-specific value; see the related workflow and schema.
error fields
FieldTypeDescription & constraints
error.codeRequiredvalidation | unauthorized | not_found | conflict | unavailable | rate_limitedPrivate activation or recovery code supplied to the driver.
error.messageRequiredstringResource-specific value; see the related workflow and schema.
Illustrative response
{
  "error": {
    "code": "unavailable",
    "message": "Required persistence or credential operation unavailable."
  }
}
Response schema
{
  "$ref": "#/components/schemas/Error"
}
← All endpointsIntegration workflows →