> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinq.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Blinq Public API

> The Blinq API provides programmatic access to your contacts and notes.

Download OpenAPI Document: [JSON](/api-reference/openapi.json) · [YAML](/api-reference/openapi.yaml)

The Blinq API provides programmatic access to your contacts and notes. Connect Blinq to your existing tools, keep contact records in sync, and build workflows on note summaries and transcripts.

API access requires a [Blinq Pro or Business plan](https://blinq.me/pricing) and a verified email address. Keys are personal and scoped: they never grant access beyond what their owner can already see.

## Access scopes

Choose one or more scopes when creating a key.

| Scope | Grants access to |
| - | - |
| `blinq:contacts:read` | Your personal contacts. Business owners and admins can list contacts; members can retrieve a visible contact by a known ID. |
| `blinq:cards:read` | Lightweight card summaries and sharing links in your personal workspace and business workspaces you own or administer. |
| `blinq:notes:read` | Your own notes and transcripts. |
| `blinq:identity:read` | Your identity and the workspaces you belong to. |

## Creating and revoking keys

1. In the Blinq web app, open Settings > API keys.
2. Select **Create new key**, choose a name and the scopes your integration needs, then select **Generate API key**.
3. Copy the key when it is shown. The secret is displayed only once; store it securely.

To revoke a key, return to Settings > API keys and select **Revoke**. A revoked key stops authenticating new requests immediately.

## Quick start

Send your key to `https://api.blinq.me` as `Authorization: Bearer <api-key>`. In the documentation playground, enter only the key, without `Bearer`.

List your notes (requires `blinq:notes:read`):

```bash theme={null}
curl 'https://api.blinq.me/v1/notes?limit=5' \
  -H 'Authorization: Bearer <api-key>'
```

Contact routes are scoped to one workspace. `GET /v1/workspaces` (requires `blinq:identity:read`) discovers workspace IDs; listing contacts from a known workspace ID needs only `blinq:contacts:read`:

```bash theme={null}
curl 'https://api.blinq.me/v1/workspaces/<workspace-id>/contacts?limit=5' \
  -H 'Authorization: Bearer <api-key>'
```

## Errors

All errors return a JSON body with `status` (the HTTP status code), `error` (the HTTP status name, such as `Bad Request`), `code` (a machine-readable error code), `message` (a human-readable description; wording may change, so branch on `code` instead), and `request_id` (the unique ID of the request, also returned as the `X-Request-Id` header). Validation errors may add a `details` array naming each parameter or body field that failed.

Any route can return `400` when query parameters or the body are invalid (unknown query parameters are rejected), `401` when the API key is missing or invalid, `403` when the key is missing a required scope, its owner lacks permission, or the account plan does not include the operation, and `429` when the rate limit is reached (see Rate limits). Any route can also return `500` when an unexpected error occurs (quote `request_id` when contacting support) and `503` when API key verification or the requested operation is unavailable.

The responses documented on each route below list only the status codes specific to that operation.

## Rate limits

Each person can make up to **25 requests in any 5-second window**, or **300 requests per minute** at a steady rate. The quota is shared across all of their API keys; creating more keys does not increase it. When the limit is reached, the API returns `429 Too Many Requests` with a `Retry-After` header in seconds. Wait that long before retrying.

## Contacts

List contact summaries or get contact details, saved contact notes, and linked note metadata.

Contact lists include personal contacts and contacts in business workspaces the authenticated user owns or administers. Business members receive an empty list, but can retrieve a visible business contact by known ID.

Requires the `blinq:contacts:read` scope.

## Cards

List or get lightweight card summaries: the name, title, company, department, and public sharing URL on each card.

Card routes are scoped to one workspace: your personal workspace or a business workspace you own or administer. Business members cannot read team cards.

Requires the `blinq:cards:read` scope.

## Notes

List note metadata, get note content and transcripts, search notes, or generate answers with citations.

Only notes owned by the authenticated user are accessible.

Requires the `blinq:notes:read` scope.

## Workspaces

List every workspace the authenticated user belongs to, with its type and their role.

Use a known workspace ID directly, or discover it here. Business contact listing requires owner or admin; retrieving a visible contact by known ID also allows members.

Requires the `blinq:identity:read` scope.

## Me

Identify the user the supplied API key acts as, with their ID and sign-in email.

Confirm whose account an integration is accessing before listing workspaces or fetching data.

Requires the `blinq:identity:read` scope.

***

### Need help?

For any questions or issues, [contact Blinq support](https://support.blinq.me/en/) or email [support@blinq.me](mailto:support@blinq.me).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.