Ir al contenido
BenchKey Ayuda

BenchKey API

Esta página aún no está disponible en tu idioma.

The BenchKey public API provides REST endpoints for customers, tickets, invoices, estimates, recorded payments, appointments, inventory, reports, webhooks, and other listed resources. Each reference states its supported operations; some app actions, including live clock-in/out and membership charging, are not exposed.

API access requires the Business plan and an environment where the public API is enabled. Check availability before building an integration. A key labeled bk_test_ still uses its workspace’s real data; see Authentication.

What you can build

Section titled “What you can build”
  • Integrations: sync customers and tickets with your own systems or external CRMs.
  • Automation: create tickets from intake forms, trigger messages, update statuses from kiosks or external devices.
  • Reporting: pull ticket history, payment totals, and inventory data into your own dashboards.
  • Custom workflows: build tooling that fits your specific shop’s process.

Base URL

Section titled “Base URL”

All API requests go to:

https://app.benchkey.com/api/v1

API versioning

Section titled “API versioning”

The API identifies its current implementation in the response header:

BenchKey-Version: 2026-06-13

The current server exposes one implementation. Sending BenchKey-Version in a request does not select or pin a historical version. Use the deployed OpenAPI specification to check supported fields and operations.

OpenAPI spec

Section titled “OpenAPI spec”

A machine-readable OpenAPI 3.0 spec is available at:

https://app.benchkey.com/api/v1/openapi.json

Use it to generate client libraries, import into Postman or Insomnia, or drive contract tests.

Explore the reference

Section titled “Explore the reference”
  • Authentication, API keys, Bearer auth, scopes, test vs. live mode
  • Quickstart, your first request in under five minutes
  • Errors, error envelope, all error codes, HTTP status meanings
  • Pagination, cursor-based pagination with next_cursor and has_more
  • Rate limits, limits, response headers, backoff advice
  • Idempotency, safe retries with Idempotency-Key
  • Webhooks, subscribe to events, verify signatures, handle retries

Resources

Section titled “Resources”

Work orders & workflow

  • Tickets, the core repair/work-order record
  • Statuses, discover your ticket status catalog, queues, and lead statuses
  • Warranty claims, coverage lookup and post-repair claims
  • Appointments, bookings, availability slots, complete/no-show
  • Assets, customer devices tracked across visits
  • Files, ticket attachments

Customers & leads

Money

Catalog & inventory

Team & workspace
Estado del sistema