Skip to main content
GET

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml
x-api-language
enum<string>[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Available options:
all,
ar_AR,
bg_BG,
bn_IN,
ca_ES,
cs_CZ,
cy_GB,
da_DK,
de_DE,
en_GB,
en_US,
el_GR,
es_NN,
es_LA,
et_EE,
fa_NN,
fi_FI,
fr_FR,
fr_CA,
he_IL,
hi_IN,
hr_HR,
hu_HU,
hy_AM,
it_IT,
ja_JP,
ko_KR,
lt_LT,
ms_MY,
nl_NL,
nb_NO,
pl_PL,
pt_BR,
ro_RO,
ru_RU,
sk_SK,
sl_SI,
sq_AL,
sr_RS,
sv_SE,
sw_NN,
th_TH,
tr_TR,
uk_UA,
vi_VN,
zh_CN,
zh_HK

Path Parameters

chapter_slug
string
required

Slug of the chapter.

Pattern: ^[A-Za-z]{8}$

Response

Chapter retrieved.

Grouping that categories can be made available in.

Includes its translated name and description, the season it belongs to, and the users who manage it. Use chapters to partition a program — for example by region or division — and delegate day-to-day management to chapter managers.

created
string<date-time>

Date and time when the chapter was created.

description
object

Description shown for the chapter.

Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.

managers
object[]

Users who manage the chapter.

name
object

Display name of the chapter.

Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.

season
object

Season the chapter belongs to.

slug
string

Short URL-safe identifier for the chapter.

status
string

Localized status label for the chapter, such as Active or Inactive, rendered according to the request's X-Api-Language.

This is the response form and differs from the value used when creating or updating a chapter, which is the active or inactive enum.

updated
string<date-time>

Date and time when the chapter was last updated.