Skip to main content
GET
Get allocation

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

allocation_slug
string
required

Slug of the allocation.

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

Response

Allocation retrieved.

Award of funds from a fund's budget to an application, the grant slot that allocation payments draw against.

amount
number

Total amount allocated to the application from the fund, in the fund's currency.

applicant
object | null

Applicant who owns the application, null when there is none.

application
object | null

Application the allocation belongs to, null when there is none.

chapter
object | null

Chapter the application belongs to, null when there is none.

created
string<date-time>

Date and time when the allocation was created.

currency
string

ISO 4217 currency code of the allocation's amounts, drawn from the fund's currency.

fund
object

Fund the allocation draws from.

paid
number

Outstanding amount due on the allocation, in the fund's currency.

season
object

Season the allocation belongs to.

slug
string

URL-safe identifier of the allocation.

updated
string<date-time>

Date and time when the allocation was last updated.