Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Project-scoped API key, e.g. nohead_sk_k7fz0a9c3m2q_<secret>, or nohead_pk_… for a published-only key. Used by servers, CI, the CLI and coding agents.

Path Parameters

record_id
string
required

Query Parameters

rich_text
enum<string>
default:document

How rich text fields read in the records and drafts returned (and in records they embed with expand): document, the stored ProseMirror JSON document; html, an HTML fragment of known elements with every text and attribute escaped, to put in a page as it is; or markdown (GitHub Flavored), which reads back as the same document when written. Images render with their URLs, so they need no expand: in HTML a WebP rendition at most 1600 pixels wide with its width and height (an SVG as itself), in Markdown the asset's image_url. An image whose asset was deleted is left out of HTML, and written as its asset ID in Markdown. Record history keeps documents.

Available options:
document,
html,
markdown
expand
string

Comma-separated relation, asset or rich text field keys whose records or assets to embed under expanded (at most 5); for a rich text field, the assets its images show. Embedding needs permission to read what is embedded: records:read for relations, assets:read for assets and rich text (403 otherwise).

Response

The record.

id
string
required
Example:

"rec_01J9ZQ3F8X5W2K7M4N6P0R1S2T"

object
any
required
collection_id
string
required
collection
string
required

The collection slug.

published_at
string<date-time> | null
required

When the record was published; null while it is unpublished.

revision
integer
required

Current revision number; also returned as the ETag.

schema_version
integer
required
history_pruned_through
integer | null
required

Revisions up to this number (except revision 1) were removed by the plan's history retention.

deleted_at
string<date-time> | null
required

When the record was soft-deleted; null unless it is.

purge_after
string<date-time> | null
required

When a soft-deleted record is removed for good, unless restored first.

data
object
required

Field values keyed by field key.

A rich text value is written as Markdown (GitHub Flavored, a string) or as a ProseMirror JSON document ({"type": "doc", "content": [...]}), and stored and read as the document (rich_text reads it as HTML or Markdown). Markdown is converted as closely as the vocabulary allows: headings below h3 become h3, task list items plain items, footnotes and raw HTML text. A document uses the web editor's vocabulary (Tiptap's StarterKit and tables) and nothing else; another name is refused with invalid_format, naming ours where one fits (strong is bold):

  • blocks: paragraph, heading (level 1-3), blockquote, bulletList and orderedList (start, type) of listItem (starting with a paragraph), codeBlock (language), horizontalRule, and table of tableRow of tableHeader or tableCell (colspan, rowspan, colwidth, align); any block may have dir (auto, ltr, rtl);
  • inline: text (non-empty) and hardBreak;
  • marks on text: bold, italic, strike, underline, code (alone), and link (href, and target, rel, class, title); a link's href is an http, https, mailto, tel or relative URL.

An image of an asset is {"type": "image", "attrs": {"asset_id": "ast_...", "alt": "..."}} (in Markdown ![alt](ast_...), or the asset's image_url), between the document's blocks (not inside a list, quote or table), at most 100 per document (too_many_images); a newly shown image must be an uploaded JPEG, PNG, GIF, WebP, AVIF or SVG of the project (invalid_reference, type_not_accepted). expand embeds the assets, and published-only keys can read the images of published records. A record holds at most 2,000,000 bytes of values, all fields together (too_large on data); one already larger can still be edited without growing.

Example:
created_at
string<date-time>
required

ISO 8601 timestamp in UTC.

Example:

"2026-09-27T12:00:00.000Z"

updated_at
string<date-time>
required

ISO 8601 timestamp in UTC.

Example:

"2026-09-27T12:00:00.000Z"

expanded
object

Only with expand: what each requested relation, asset or rich text field points at, keyed by field key: records for relation fields, assets for asset fields. A single value is the object, or null when it no longer exists; a multiple value is a list of those that still exist. For a rich text field, the list of assets its images show, in document order, leaving out those that no longer exist. Expanded records are not expanded further.