Skip to main content
GET
Get tab

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

tab_slug
string
required

Slug of the tab.

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

Response

Tab retrieved.

Section of a form that groups what is collected from applicants, such as application details, custom fields, attachments, contributors, or referees.

categories
(object | enum<string>)[]

Categories the tab is shown in, or ["*"] when it is shown in every category.

category_option says which of the two a tab is using, so read that rather than testing for the marker. The same shape is used by the categories property of a field.

category_option
enum<string>

How categories are applied to the tab.

  • all - Shown in every category.
  • select - Shown only in the categories listed in categories.
Available options:
all,
select
content_block
object | null

Content block shown at the top of the tab, or null when no content block is assigned.

created
string<date-time>

Date and time when the tab was created.

field_count
integer

Number of fields attached to the tab.

form
string

Slug of the form the tab belongs to.

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

Specifies whether the tab is locked.

A locked tab always holds position 1 and you cannot reorder or delete it.

name
object

Display name of the tab, as a map of translated strings keyed by locale code.

order
integer

Position of the tab within the form, where lower values appear first.

resource
enum<string>

Resource the tab collects data for.

  • applications - Part of an application form.
  • users - Part of the user profile form.
Available options:
applications,
users
season
object

Season the tab belongs to.

settings
object | null

Configuration that applies only to this type of tab, or null for a type that carries none, such as a details or fields tab.

Each type populates its own properties and omits the rest: an attachments tab carries the upload limits, an eligibility tab the assessment and communication settings, a referees tab the reference limits, and a contributors tab the contributor limits.

These are the limits the applicant form applies. Apply them in your own interface so that applicants do not upload files the form would refuse.

Example:
slug
string

Short URL-safe identifier for the tab.

tab_divider_on_pdfs
boolean

Specifies whether generated PDF documents include a divider page for the tab.

type
enum<string>

Type of the tab, which determines what the tab collects.

  • details - Core application details, such as the application title and the category the application is submitted to.
  • attachments - Supplementary files uploaded against the application.
  • contributors - People credited on the application alongside the applicant.
  • fields - Answers to the custom fields on the form.
  • eligibility - Answers used to assess whether the application is eligible.
  • referees - Referees asked to provide a reference for the application.
Available options:
details,
attachments,
contributors,
fields,
eligibility,
referees
updated
string<date-time>

Date and time when the tab was last updated.

visible_to_applicants
boolean

Specifies whether applicants see the tab.

A tab hidden from applicants stays visible to program managers, so use it to collect information applicants do not manage themselves.