Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

content:images:read

Path Parameters

_id
string
required

The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Query Parameters

render-areas
boolean
default:false

true: each area’s widgets come back rendered as HTML (_rendered), beside their data.

Response

Success

ImageFolder content type

title
string
default:""
required

Its title: the name it goes by in every list, and the heading of its page where it has one.

slug
string
default:""
required

The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

visibility
enum<string>
default:public
required

Select whether this content is public or private

Available options:
public,
loginRequired
_id
string
required
read-only

The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.

type
string
required
read-only

The document type’s name: always this type’s.

createdAt
string<date-time>
required
read-only

When it was created (ISO 8601).

updatedAt
string<date-time>
required
read-only

When it last changed (ISO 8601).

_parent
Parent folder · object[] | null

The related image-folder documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out.

Maximum array length: 1
referenceOnly
boolean | null
default:false

Media in this folder (and every folder inside it) are kept for comparison only: you can browse them here, but they can never be used on the site.

archived
boolean | null
default:false

In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

folderPath
string | null
default:""

Its place in the tree: each folder’s URL name from the top, joined by / (albums/summer). Set by the site from _parent and title; a value sent is ignored.

folderParentId
string | null
default:""

The parent folder’s id, empty at the top. Set by the site from _parent; a value sent is ignored.

slugSegment
string | null
default:""

Its own part of folderPath, made from its title. Set by the site; a value sent is ignored.

level
integer | null
default:0

How deep it sits: 0 at the top. Set by the site from _parent; a value sent is ignored.

linkedAlbumId
string | null
default:""

On a folder the site made for a Photo Album, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

linkedFeedId
string | null
default:""

On a folder the site made for a Photo Feed, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.

linkedDocId
string | null
default:""

On a folder the site made for a page’s or post’s feed photos, that one’s id; empty otherwise. Owned by the site: an update keeps the stored value whatever it sends.