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:redirects: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

Redirect 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.

redirectSlug
string
default:""
required

Format with leading slash (e.g., /old-url)

slug
string
default:""
required

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

_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).

urlType
enum<string> | null
default:internal

Link Type.

Available options:
internal,
external,
null
_newPage
Page Title · object[] | null

The related @apostrophecms/page 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
externalUrl
string | null

When set, a URL; empty or null when not.

statusCode
enum<string> | null
default:301

Redirect Type.

Available options:
302,
301,
null
ignoreQueryString
boolean | null
default:false

Ignore query string when matching.

forwardQueryString
boolean | null
default:false

Forward query string.

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.