# bind.co API

> bind.co is a consent-scoped API for the inbox: it turns what an inbox owner has agreed to share with your application into structured, confirmed records.

Every page below is plain text or HTML that needs no JavaScript.

## Guides

- [Quickstart](https://api.bind.co/docs/quickstart.md): from a new application to your first record and your first webhook.
- [What you can build](https://api.bind.co/docs/build-with-bind.md): four applications you can build on bind.co, with the scopes each needs.
- [Recipe: map your network](https://api.bind.co/docs/recipe-map-your-network.md): everyone the user works with, what each is to them, and when they last spoke.
- [Recipe: client re-engagement](https://api.bind.co/docs/recipe-client-reengagement.md): the user's clients, why each is worth contacting now, and an email ready to send.
- [Recipe: expense capture](https://api.bind.co/docs/recipe-expense-capture.md): receipts and invoices from the mail as expense records to review and approve.
- [Recipe: document collection](https://api.bind.co/docs/recipe-document-collection.md): what is missing on each record, documents already in the mailbox, and messages to ask for the rest.
- [Profile](https://api.bind.co/docs/profile.md): the user, their profile and their companies, and how suggestions work.
- [Contacts and roles](https://api.bind.co/docs/contacts-and-roles.md): one contact, many roles: how bind.co builds them, merges them and keeps your edits.
- [Emails](https://api.bind.co/docs/emails.md): what an email is in bind.co, and how it links to records.
- [Files](https://api.bind.co/docs/files.md): attachments, one file per user, and how files become evidence.
- [Drafts and goals](https://api.bind.co/docs/drafts-and-goals.md): the emails bind.co suggests for the user's contacts, and the goals that shape them.
- [Operations](https://api.bind.co/docs/operations.md): records found in the mail: their lifecycle, evidence, confidence, documents and the chaser.
- [Mailbox sync](https://api.bind.co/docs/mailbox-sync.md): how the webhooks tell you about new mail, and what a sync never changes.
- [Authentication and scopes](https://api.bind.co/docs/authentication.md): the consent chain, the scopes each route needs, token lifetimes, refresh and revocation.
- [Webhooks](https://api.bind.co/docs/webhooks.md): registering endpoints, verifying signatures, and every event type with its payload.
- [Pagination and idempotency](https://api.bind.co/docs/pagination-and-idempotency.md): paging through lists, and retrying writes safely with `Idempotency-Key`.
- [Errors](https://api.bind.co/docs/errors.md): the error envelope and every `error` code, deep-linked from `error_uri`.
- [Rate limits](https://api.bind.co/docs/rate-limits.md): every limit and budget, and the `429` / `Retry-After` contract.
- [Test your integration](https://api.bind.co/docs/testing.md): who can sign in to your application at each review status, and how to test end to end on your own data.
- [Generate a client](https://api.bind.co/docs/generate-a-client.md): a typed client for your language, generated from the OpenAPI reference.
- [Changelog](https://api.bind.co/docs/changelog.md): every change to the API, and what to change in your client.

## Reference

- [OpenAPI document](https://api.bind.co/v1/openapi.json): every public `/v1` route, with its scopes, parameters, bodies, answers and examples.
- [Webhook event types](https://api.bind.co/v1/docs/webhooks/event-types): the live list of subscribable event types, as JSON.
- [Changelog feed](https://api.bind.co/docs/changelog.atom): the changelog as an Atom feed.