Skip to main content

REST API

Our REST API exposes versioned HTTP endpoints with predictable resource URLs and RFC-compliant error responses. Use it for conventional CRUD-style integrations, webhooks, and background jobs.

Endpoints​

  • Production: https://api.tourfold.com/api/v2/

Reference​

Start here​

  • Conventions: Basics covers naming, date formats, pagination cursors, and URL structure.
  • Authentication: Auth explains OAuth2/OIDC access tokens and service accounts for server-to-server integrations.
  • Errors: Shared Errors for REST and GraphQL.

Common guides​

Definition discovery​

GET /api/v2/definitions/all lists visible concrete Object, Vehicle and Task definitions and supported native projections. Internal Vehicle and Task family roots are excluded. Use GET /api/v2/definitions/all/{definition_ref} for a slug or UUID; unavailable and hidden definitions return 404. Lists accept page and size (1–100), ordered by slug then UUID after permission filtering.

Owner detail, list and write responses and discovery use the same definition representation for the same caller and revision. resource_type is object, vehicle, task or a registered native key. Family ancestry is internal; Task behavior is described by execution_type. Record definition_id still identifies the selected definition.

Discovery grants no record access. Author definitions through the Object, Vehicle or Task API. GraphQL keeps its own schema and connection representation.

Example request​

curl -X GET "https://api.tourfold.com/api/v2/areas" \
-H "Authorization: Bearer YOUR_TOKEN"