> ## 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. # Search notes > Searches the authenticated user's indexed note titles and bodies, including recording summaries and saved text, using keyword and semantic matching. Returns up to `limit` results ordered from most to least relevant. Search does not support pagination. `is_truncated` indicates that additional results were found. New or updated notes may be missing until indexing completes. Changing `limit` can change the ranking. Use the list endpoint to retrieve all notes and the get endpoint to read note content. Requires the `blinq:notes:read` scope. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/notes/search openapi: 3.1.0 info: title: Blinq Public API version: 1.0.0 description: >- 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 `. In the documentation playground, enter only the key, without `Bearer`. List your notes (requires `blinq:notes:read`): ```bash curl 'https://api.blinq.me/v1/notes?limit=5' \ -H 'Authorization: Bearer ' ``` 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 curl 'https://api.blinq.me/v1/workspaces//contacts?limit=5' \ -H 'Authorization: Bearer ' ``` ## 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. servers: - url: https://api.blinq.me security: [] tags: - name: Contacts description: >- 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. - name: Cards description: >- 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. - name: Notes description: >- 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. - name: Workspaces description: >- 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. - name: Me description: >- 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. paths: /v1/notes/search: get: tags: - Notes summary: Search notes description: >- Searches the authenticated user's indexed note titles and bodies, including recording summaries and saved text, using keyword and semantic matching. Returns up to `limit` results ordered from most to least relevant. Search does not support pagination. `is_truncated` indicates that additional results were found. New or updated notes may be missing until indexing completes. Changing `limit` can change the ranking. Use the list endpoint to retrieve all notes and the get endpoint to read note content. Requires the `blinq:notes:read` scope. operationId: searchNotes parameters: - schema: type: string minLength: 1 example: launch pricing in: query name: query required: true description: >- Search terms to match against indexed titles and bodies, including recording summaries and saved text. - schema: default: 10 type: integer exclusiveMinimum: 0 maximum: 25 in: query name: limit required: false description: >- The maximum number of search results to return. Search does not support pagination. responses: '200': description: Search results ordered by relevance. content: application/json: schema: type: object properties: notes: type: array items: type: object properties: id: type: string description: The ID of the note. title: anyOf: - type: string - type: 'null' description: >- The custom title set by the user, otherwise the generated title, or `null` when the note has neither. created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ description: >- When the user's device created the note, as an ISO 8601 timestamp. updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ description: >- When the note was last updated, as an ISO 8601 timestamp. deleted_at: type: 'null' description: Always `null`. Deleted notes are not returned. status: type: string enum: - processing - ready - failed - blocked description: >- The processing state of the note. `processing`: recording or processing is in progress. `ready`: no recording or processing is pending. Content may be empty or null. `failed`: processing failed. Partial content may be available. `blocked`: processing is blocked by the account plan or usage limits. type: anyOf: - type: string enum: - voice_note - phone_call - text - type: 'null' description: >- How the note was captured: a recorded `voice_note`, a recorded `phone_call`, or a typed `text` note. `null` when the type is unavailable. share_url: anyOf: - type: string - type: 'null' description: >- A URL for viewing the note in a browser, or `null` when the note has no share link. Reading a note never creates a share link or changes sharing settings. linked_contacts: type: array items: type: object properties: id: type: string description: The ID of the linked contact. full_name: anyOf: - type: string - type: 'null' description: >- The display name of the linked contact, or `null` when none is available. workspace_id: type: string description: >- The personal workspace ID to pass when getting this contact. required: - id - full_name - workspace_id additionalProperties: false description: >- The contacts linked to the note, or an empty array when there are none. Retrieving a linked contact requires `blinq:contacts:read` and contact access. required: - id - title - created_at - updated_at - deleted_at - status - type - share_url - linked_contacts additionalProperties: false description: Note metadata. example: id: note-id title: Meeting notes created_at: '2026-10-01T00:00:00.000Z' updated_at: '2026-10-01T00:00:00.000Z' deleted_at: null status: ready type: voice_note share_url: https://note.blinq.me/share-id linked_contacts: - id: contact-id full_name: Jane Doe workspace_id: workspace-id description: >- Note metadata ordered from most to least relevant. Results may omit notes that have not been indexed. is_truncated: type: boolean description: >- Whether this search found more results than `limit`. A value of `false` does not guarantee that every note was searched. Use the list endpoint to retrieve all notes. required: - notes - is_truncated additionalProperties: false description: Search results ordered by relevance. example: notes: - id: note-id title: Pricing discussion created_at: '2026-10-01T00:00:00.000Z' updated_at: '2026-10-01T00:00:00.000Z' deleted_at: null status: ready type: phone_call share_url: null linked_contacts: [] is_truncated: false '400': description: >- Bad request - Invalid query parameters or body. See `details` for each failing field content: application/json: schema: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The HTTP status code of the response. error: type: string description: The HTTP status name, such as `Bad Request`. code: type: string enum: - invalid_request - unauthorized - forbidden - plan_required - not_found - unsupported_media_type - rate_limited - internal_error - upstream_unavailable description: >- A machine-readable code identifying the error. Use this value for programmatic error handling. message: type: string description: >- A human-readable description. Wording may change; branch on `code` instead. request_id: type: string description: >- The unique ID of this request, also returned as the `X-Request-Id` header. Include it when contacting support. details: description: Additional validation errors, when available. type: array items: type: object properties: path: type: string description: >- The parameter or body field that failed validation, such as `limit`. Empty for errors that apply to the whole request. message: type: string description: A description of the validation error. required: - path - message additionalProperties: false required: - status - error - code - message - request_id additionalProperties: false description: >- Bad request - Invalid query parameters or body. See `details` for each failing field example: status: 400 error: Bad Request code: invalid_request message: The request is invalid. request_id: req-1 details: - path: limit message: 'Too big: expected number to be <=50' '401': description: Unauthorized - Missing or invalid API key content: application/json: schema: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The HTTP status code of the response. error: type: string description: The HTTP status name, such as `Bad Request`. code: type: string enum: - invalid_request - unauthorized - forbidden - plan_required - not_found - unsupported_media_type - rate_limited - internal_error - upstream_unavailable description: >- A machine-readable code identifying the error. Use this value for programmatic error handling. message: type: string description: >- A human-readable description. Wording may change; branch on `code` instead. request_id: type: string description: >- The unique ID of this request, also returned as the `X-Request-Id` header. Include it when contacting support. details: description: Additional validation errors, when available. type: array items: type: object properties: path: type: string description: >- The parameter or body field that failed validation, such as `limit`. Empty for errors that apply to the whole request. message: type: string description: A description of the validation error. required: - path - message additionalProperties: false required: - status - error - code - message - request_id additionalProperties: false description: Unauthorized - Missing or invalid API key example: status: 401 error: Unauthorized code: unauthorized message: Missing or invalid API key. request_id: req-1 '403': description: >- Forbidden - Missing scope, insufficient permission, or the plan does not include this operation content: application/json: schema: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: The HTTP status code of the response. error: type: string description: The HTTP status name, such as `Bad Request`. code: type: string enum: - invalid_request - unauthorized - forbidden - plan_required - not_found - unsupported_media_type - rate_limited - internal_error - upstream_unavailable description: >- A machine-readable code identifying the error. Use this value for programmatic error handling. message: type: string description: >- A human-readable description. Wording may change; branch on `code` instead. request_id: type: string description: >- The unique ID of this request, also returned as the `X-Request-Id` header. Include it when contacting support. details: description: Additional validation errors, when available. type: array items: type: object properties: path: type: string description: >- The parameter or body field that failed validation, such as `limit`. Empty for errors that apply to the whole request. message: type: string description: A description of the validation error. required: - path - message additionalProperties: false required: - status - error - code - message - request_id additionalProperties: false description: >- Forbidden - Missing scope, insufficient permission, or the plan does not include this operation examples: example1: value: status: 403 error: Forbidden code: forbidden message: You do not have access to the requested resource. request_id: req-1 example2: value: status: 403 error: Forbidden code: plan_required message: >- The API key owner must have a Blinq Pro or Business plan to use this endpoint. request_id: req-1 security: - API key: [] components: securitySchemes: API key: type: http scheme: bearer description: >- Send a Blinq API key as `Authorization: Bearer `; enter only the key in the documentation playground. Create and revoke keys in the Blinq web app under Settings > API keys. The key needs the scopes required by the operation, and public API access requires a Pro or Business plan. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.