Objects

Get an Object by id

Retrieve a single Object by its id. To fetch by slug instead, query the Objects list endpoint with query={"type":"...","slug":"..."}.

get/buckets/{slug}/objects/{object_id}

Query parameters

read_keystring

The Bucket read key. Required unless the Bucket has no read key configured.

preview_tokenstring

A short-lived JWT issued by the Cosmic dashboard (object editor > Preview). When present and valid, the request is treated as status=any so the latest draft is returned. Bound to one Bucket for one hour. Still requires read_key. Invalid or expired tokens return 401.

propsstring

Comma-separated list of properties to return, including nested metadata paths. Omit to return everything. Narrowing props is the main way to keep responses under the 6 MB response cap and to reduce latency.

status'published' | 'draft' | 'any'

Which version of each Object to return. any returns the latest draft or published version.

depthinteger

How many levels of Object Relationship Metafields to resolve into nested Objects. Circular references are rejected.

useCacheboolean

Set to false to bypass the cache and read through to the database. Guarantees you see writes you just made, at the cost of higher latency.

prettyboolean

Set to true to indent the JSON response for human reading. Increases response size.

Response

The requested Object.

Changes

No recorded changes to this endpoint across all 1 revision of this API.