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

​
form_slug
string
required

Slug of the form.

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

Response

Form retrieved.

Form used to collect applications within a season.

Carries the translated name and call to action, the season it belongs to, its type, and its chapter and content-block settings.

​
callToAction
object

Call to action of the form.

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.

​
chapter_option
enum<string>

How chapters are applied to the form.

  • all - Available to every chapter.
  • select - Available to selected chapters only.
Available options:
all,
select
​
content_block
object | null

Content block displayed with the form.

null when no content block is assigned.

​
created
string<date-time>

Date and time when the form was created.

​
name
object

Name of the form.

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 | null

Season the form belongs to.

null when the form is not assigned to a season.

​
slug
string

URL-safe identifier of the form.

​
type
enum<string>

Type of the form.

  • application - Collects applications.
  • report - Collects grant reports.
Available options:
application,
report
​
updated
string<date-time>

Date and time when the form was last updated.