bind.co API guides
Start with the Quickstart. The API reference documents every public route;
its OpenAPI document is /v1/openapi.json.
- Quickstart — from a new application to your first record and your first webhook.
- Build with bind.co
- What you can build — four applications you can build on bind.co, with the scopes each needs.
- Recipe: map your network — everyone the user works with, what each is to them, and when they last spoke.
- Recipe: client re-engagement — the user's clients, why each is worth contacting now, and an email ready to send.
- Recipe: expense capture — receipts and invoices from the mail as expense records to review and approve.
- Recipe: document collection — what is missing on each record, documents already in the mailbox, and messages to ask for the rest.
- Concepts
- Profile — the user, their profile and their companies, and how suggestions work.
- Contacts and roles — one contact, many roles: how bind.co builds them, merges them and keeps your edits.
- Emails — what an email is in bind.co, and how it links to records.
- Files — attachments, one file per user, and how files become evidence.
- Drafts and goals — the emails bind.co suggests for the user's contacts, and the goals that shape them.
- Operations — records found in the mail: their lifecycle, evidence, confidence, documents and the chaser.
- Mailbox sync — how the webhooks tell you about new mail, and what a sync never changes.
- Authentication and scopes — the consent chain, the scopes each route needs, token lifetimes, refresh and revocation.
- Webhooks — registering endpoints, verifying signatures, and every event type with its payload.
- Pagination and idempotency — paging through lists, and retrying writes safely with
Idempotency-Key. - Errors — the error envelope and every
errorcode, deep-linked fromerror_uri. - Rate limits — every limit and budget, and the
429/Retry-Aftercontract. - Test your integration — 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 — a typed client for your language, generated from the OpenAPI reference.
- Changelog — every change to the API, and what to change in your client.
- Webhook event types (JSON) — the live list of subscribable types (no authentication, 60 requests per minute).
Each guide is also available as markdown at the same path with .md appended, and /llms.txt
indexes them for language models.