API reference
The Shortcut REST API - base URL, authentication, and every object it returns. Endpoints are rendered from the OpenAPI description.
The Shortcut API is a REST API with predictable resource paths, JSON request and response bodies, standard HTTP status codes, and bearer-token authentication. It has 138 endpoints, rendered in this section from the OpenAPI 3.1 description at https://api.shortcutco.com/v1/openapi.json, each with samples in curl, Node.js, and Python.
https://api.shortcutco.com/v1Send a token from Settings → API & integrations in the Authorization header on every request. Each endpoint lists the scopes it needs. See Workspaces and tokens and Scopes.
Every endpoint follows the same conventions: a data envelope, cursor pagination on most lists, Idempotency-Key on writes, typed errors, and ISO 8601 timestamps in UTC.
Objects
Each object is defined once, on its own page, with its fields, an example, and the endpoints that return it: token, contact preferences, customer, review request, timeline event, property, property access, lead, note, activity post, attachment, action, conversation, message, metric, automation, project, quickbooks status, chemical application, task, estimate, estimate reminder, job, visit, visit completion, credit memo, invoice, invoice delivery, refund, payment, payment reversal, service, product, tag, custom field, team, user, webhook, webhook delivery. See Objects.
Endpoints
The endpoints follow, one page per resource, each with its scopes, parameters, request and response fields, samples, and examples. To use them from code, start from the samples; the OpenAPI description generates typed clients.
Last updated