# Public API

> Read and write customers, deals, tickets, meetings and the live chat inbox over REST, with an OpenAPI document to build against.

- Canonical page: https://hispecular.com/docs/public-api
- Section: Developers
- Updated: 2026-10-22

The REST API reads and writes what you see in the workspace: customers, companies, leads, deals, tasks, notes, support tickets, meetings and the live chat inbox. It is included on Pro and Enterprise. Everything is JSON over HTTPS, and every endpoint is described in an OpenAPI document you can build against.

## What it covers

| Area | You can |
| --- | --- |
| [People](https://hispecular.com/docs/api-reference/people) | Create, read, update, search and archive customers. |
| [Companies](https://hispecular.com/docs/api-reference/companies) | The same for accounts. |
| [Leads](https://hispecular.com/docs/api-reference/leads) | Track and qualify people who have shown interest. |
| [Opportunities](https://hispecular.com/docs/api-reference/opportunities) | Deals: move them through a pipeline, win and lose them. |
| [Pipelines](https://hispecular.com/docs/api-reference/pipelines) | Read pipelines and their stages. |
| [Custom objects](https://hispecular.com/docs/api-reference/custom-objects) | Work the records of objects your workspace defines. |
| [Tasks](https://hispecular.com/docs/api-reference/tasks) | Create, change, complete and delete work for your team. |
| [Notes](https://hispecular.com/docs/api-reference/notes) | Add, edit, pin and delete notes on records. |
| [Tickets](https://hispecular.com/docs/api-reference/tickets) | Open tickets about a record and move them along. |
| [Meetings](https://hispecular.com/docs/api-reference/meetings) | Schedule, move and cancel meetings, with invitations. |
| [Inbox](https://hispecular.com/docs/api-reference/inbox) | Read live chats, take them over from the AI agent, reply, hand back. |
| [Team](https://hispecular.com/docs/api-reference/team) | List the people in the workspace, for owners and assignees. |
| [Webhooks](https://hispecular.com/docs/api-reference/webhooks) | Subscribe an address to events, instead of polling. |

## Quickstart

1. Open Settings → API and create a key with the scopes you need. Copy it straight away; it is shown once. See [Authentication and scopes](https://hispecular.com/docs/api-authentication).
2. Send it as a bearer token. This lists the most recently changed customers.

```bash
curl https://hispecular.com/api/v1/people \
  -H "Authorization: Bearer sk_live_YOUR_KEY"
```

1. Create a customer. The key needs the people write scope.

```bash
curl -X POST https://hispecular.com/api/v1/people \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: signup-form-2026-11-05-emily" \
  -d '{"display_name": "Emily Carter", "email": "emily@example.com"}'
```

The response is `{ "data": { "id": "pr_…", … } }`. Use that id to read, change or archive the customer, or to link a deal, task, note or ticket to them.

## Where to go next

- [Requests and responses](https://hispecular.com/docs/api-conventions): pages, filters, errors, retries and limits.
- [Webhooks](https://hispecular.com/docs/webhooks): know the moment something changes.
- [Recipes](https://hispecular.com/docs/api-recipes): common jobs, start to finish.
- [API reference](https://hispecular.com/docs/api-reference) and the [OpenAPI document](https://hispecular.com/api/v1/openapi.json) to generate a client, and a [Postman collection](https://hispecular.com/api/v1/postman.json) with every request ready to send.
- [MCP server](https://hispecular.com/docs/api-mcp): let an AI agent use the API.