Response Fields

1 min readStableIntermediate

The ResponseField component documents the shape of API response bodies — name, type, and required status, with dot notation for nested objects.

Quick Start

Two required fields.

idstringrequired

Unique identifier for the resource.

titlestringrequired

Document title as provided during creation.

Optional fields and a type label.

createdAtstring (ISO 8601)

Timestamp of when the document was created.

statusstring

Current document status. Only included for authenticated editors.

Nested objects using dot notation.

paginationobjectrequired

Pagination metadata for navigating result pages.

pagination.pageintegerrequired

Current page number.

pagination.totalintegerrequired

Total number of items across all pages.

pagination.hasMorebooleanrequired

Whether additional pages are available.

namestringrequired

Field name; use dot notation for nesting.

typestring

Data type label.

requiredbooleanDefault: false

Shows a red "required" label.

deprecatedbooleanDefault: false

Shows an amber "deprecated" label.

childrenReactNode

Description text under the field; supports inline Markdown.

Was this page helpful?