# Ordstage API docs

> Developer documentation for the Ordstage API: connect your own systems (a clinic system, a hotel PMS, a booking site, a CRM) to Ordstage with a REST API, signed webhooks and a sandbox for test keys.

Every page is also available as Markdown (the links below). Production API: https://api.ordstage.com. The OpenAPI document: https://www.ordstage.com/docs/openapi.json

## Guides

- [Ordstage API](https://www.ordstage.com/docs/index.md): Connect your own systems to Ordstage with a REST API, signed webhooks and a test workspace.
- [Quickstart](https://www.ordstage.com/docs/quickstart.md): Create a test key, make your first request and read the answer, in about five minutes.
- [Authentication and API keys](https://www.ordstage.com/docs/authentication.md): Key format, where to send a key, expiry, rotation, revoking, IP allowlists and keeping keys safe.
- [Sandbox and test mode](https://www.ordstage.com/docs/sandbox.md): Test keys reach a separate test workspace where nothing real is sent or charged.
- [Errors](https://www.ordstage.com/docs/errors.md): One error envelope for every failure, its types, and every error code the API answers with.
- [Pagination](https://www.ordstage.com/docs/pagination.md): Cursor pagination with limit and starting_after, and how to page through every object.
- [Idempotency](https://www.ordstage.com/docs/idempotency.md): Retry requests safely with the Idempotency-Key header.
- [Rate limits](https://www.ordstage.com/docs/rate-limits.md): Per-key request limits, the X-RateLimit headers and handling 429 answers.
- [Webhooks](https://www.ordstage.com/docs/webhooks.md): Events Ordstage sends to your endpoint, their payloads, retries, and verifying signatures in Node, Python and PHP.
- [Versioning and changelog](https://www.ordstage.com/docs/versioning.md): How the API changes, what counts as breaking, and the list of changes.
- [Business, team and access](https://www.ordstage.com/docs/business-and-team.md): Read and update the business profile, manage members and invitations, and see the business's webhooks and API keys.
- [Assistants](https://www.ordstage.com/docs/assistants.md): List assistants, publish, pause and resume them, send test messages in the sandbox, and manage the web pages they learn from.
- [Conversations](https://www.ordstage.com/docs/conversations.md): Read customer conversations and their messages, reply, hand over to the team and back to the assistant, close, reopen and label them.
- [Contacts and leads](https://www.ordstage.com/docs/contacts-and-leads.md): Create, update, tag, merge and delete contacts, and manage leads and their status.

## Reference

- [API reference](https://www.ordstage.com/docs/reference.md): Every Ordstage API endpoint and webhook, with examples and Try it.
- [OpenAPI document](https://www.ordstage.com/docs/openapi.json): the machine-readable API description.

## Optional

- [All docs in one file](https://www.ordstage.com/docs/llms-full.txt)
- [About Ordstage](https://www.ordstage.com/llms.txt)