> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference.md).

# 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 99 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/v1
```

Send a token from **Settings → API & integrations** in the `Authorization` header on every request. Each endpoint lists the scopes it needs. See [Workspaces and tokens](/developers/concepts/workspaces-and-tokens.md) and [Scopes](/developers/concepts/scopes.md).

Every endpoint follows the same [conventions](/developers/concepts/conventions.md): a `data` envelope, cursor pagination, `Idempotency-Key` on writes, typed [errors](/developers/concepts/errors.md), and ISO 8601 timestamps in UTC.

{% hint style="warning" %}
**Test it** is on read endpoints only. It sends a real request to the production API, through GitBook's proxy, with the token you paste, and reads your actual workspace: use a short-lived token with only read scopes. To try a write, copy its curl, Node.js, or Python sample.
{% endhint %}

## Objects

Each object is defined once, on its own page, with its fields, an example, and the endpoints that return it: [token](/developers/api-reference/reference/objects/token.md), [customer](/developers/api-reference/reference/objects/customer.md), [property](/developers/api-reference/reference/objects/property.md), [lead](/developers/api-reference/reference/objects/lead.md), [estimate](/developers/api-reference/reference/objects/estimate.md), [estimate reminder](/developers/api-reference/reference/objects/estimate-reminder.md), [job](/developers/api-reference/reference/objects/job.md), [visit](/developers/api-reference/reference/objects/visit.md), [visit completion](/developers/api-reference/reference/objects/visit-completion.md), [invoice](/developers/api-reference/reference/objects/invoice.md), [invoice delivery](/developers/api-reference/reference/objects/invoice-delivery.md), [payment](/developers/api-reference/reference/objects/payment.md), [payment reversal](/developers/api-reference/reference/objects/payment-reversal.md), [service](/developers/api-reference/reference/objects/service.md), [product](/developers/api-reference/reference/objects/product.md), [tag](/developers/api-reference/reference/objects/tag.md), [custom field](/developers/api-reference/reference/objects/custom-field.md), [team](/developers/api-reference/reference/objects/team.md), [user](/developers/api-reference/reference/objects/user.md), [webhook](/developers/api-reference/reference/objects/webhook.md), [webhook delivery](/developers/api-reference/reference/objects/webhook-delivery.md). See [Objects](/developers/api-reference/reference/objects.md).

## 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](https://api.shortcutco.com/v1/openapi.json) generates typed clients.