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:files:read

Query Parameters

aposMode
enum<string>
default:published

published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403.

Available options:
draft,
published
aposLocale
string

The locale to read or write, e.g. en (default: the site’s default locale).

Example:

"fr"

render-areas
boolean
default:false

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

page
integer
default:1

Page number for pagination (1-based)

Required range: x >= 1
perPage
integer

Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one.

Required range: x >= 1
search
string

Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).

slug
string

Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.

fields
string[]

Only these fields of each document, beside its _id: fields=title&fields=slug, or fields=title,slug. Use it to find a document’s _id without reading every field of every document. A page keeps its place in the tree (_children). A field the type lacks is refused (400) with the list of its fields; the public, and an API key without the type’s read scope, may name only its public fields.

Response

Successful response

A page of FileTag documents.

results
FileTag · object[]
required

This page’s documents; empty past the last page.

pages
integer
required

Pages in the whole list (0 when it is empty).

currentPage
integer
required

This page, from 1.