Skip to main content
GET
Get note

Authorizations

Authorization
string
header
required

Send a Blinq API key as Authorization: Bearer <api-key>; 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.

Path Parameters

id
string
required

The note ID.

Minimum string length: 1

Response

The requested note.

The requested note.

id
string
required

The ID of the note.

title
string | null
required

The custom title set by the user, otherwise the generated title, or null when the note has neither.

created_at
string<date-time>
required

When the user's device created the note, as an ISO 8601 timestamp.

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)))$
updated_at
string<date-time>
required

When the note was last updated, as an ISO 8601 timestamp.

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)))$
deleted_at
null
required

Always null. Deleted notes are not returned.

status
enum<string>
required

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.

Available options:
processing,
ready,
failed,
blocked
type
enum<string> | null
required

How the note was captured: a recorded voice_note, a recorded phone_call, or a typed text note. null when the type is unavailable.

Available options:
voice_note,
phone_call,
text
share_url
string | null
required

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
object[]
required

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.

content
string | null
required

The stored body: an AI summary for a recording or saved text for a text note. null means no body is stored; an empty stored body remains "". Use status to determine processing state.

content_format
null
required

Always null: the backend does not record the content format. Treat the stored body as plain text unless your integration explicitly supports its markup.

source
enum<string> | null
required

The device type that recorded the note: a mobile phone, a watch, or the Blinq notetaker device. null when unknown.

Available options:
mobile,
watch,
device