Skip to main content
GET
Get an item

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Query Parameters

itemId
string

Item id. Provide either this or the collectionId + slug pair.

Minimum string length: 1
collectionId
string

Collection to look the item up in by slug. Pair with slug.

Minimum string length: 1
slug
string

Item slug within the collection. Pair with collectionId.

Pattern: ^[a-z0-9][a-z0-9-]{0,255}$
depth
integer
default:0
Required range: 0 <= x <= 3
published

Only match a published ("true") or draft ("false") item; a mismatch reads as not found. Omit to match either.

Allowed value: "true"

Response

The item, hydrated to the requested depth.

id
string
required

Unique item id.

slug
string
required

URL-shaped identifier, unique among the collection’s active items. Lowercase letters, digits, and hyphens; max 256 characters.

publishedAt
string<date-time> | null
required

null while the item is a draft or scheduled; the actual publish timestamp otherwise.

publishAt
string<date-time> | null
required

Future publication time while the item is scheduled; null for drafts and published items.

createdAt
string<date-time>
required

Creation timestamp.

updatedAt
string<date-time>
required

Last-modification timestamp.

position
string
required

Fractional ordering key; the default list order sorts by this value.

data
object
required

One entry per field of the collection, keyed by field key; optional fields with no value read as null. Scalar fields use plain JSON values: date as an ISO 8601 string, color as normalized hex, option as a choice id (or array of ids when multi-select). reference values are the referenced item id at depth 0 or an embedded item object (this same item shape) at depth ≥ 1; multi_reference values are ordered arrays of the same. image and gallery values resolve to image objects carrying id, delivery url, originalUrl, srcSet, variants, dimensions, filename, mimeType, byteSize, and altText; file values resolve to { id, url, filename, mimeType, byteSize }. Unset asset fields read as null (or [] for galleries).