Create tab - Good Grants

curl --request POST \
  --url https://api.us.cr4ce.com/tab \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "form": "GhIjKlMn",
  "type": "fields",
  "translated": {
    "name": {
      "en_GB": "About you"
    }
  },
  "order": 20,
  "category_option": "select",
  "categories": [
    "KlMnOpQr"
  ],
  "visible_to_applicants": true,
  "tab_divider_on_pdfs": true
}
'

{
  "categories": [
    {
      "slug": "KlMnOpQr",
      "link": "https://api.au.cr4ce.com/category/KlMnOpQr",
      "name": {
        "en_GB": "Documentary"
      }
    }
  ],
  "category_option": "select",
  "content_block": null,
  "created": "2024-12-12T09:41:21Z",
  "field_count": 6,
  "form": "GhIjKlMn",
  "locked": false,
  "name": {
    "en_GB": "About you"
  },
  "order": 20,
  "resource": "applications",
  "season": {
    "slug": "EfGhIjKl",
    "link": "https://api.au.cr4ce.com/season/EfGhIjKl",
    "name": {
      "en_GB": "2026"
    }
  },
  "settings": null,
  "slug": "StUvWxYz",
  "tab_divider_on_pdfs": true,
  "type": "fields",
  "updated": "2026-04-13T13:45:50Z",
  "visible_to_applicants": true
}

{
  "message": "<string>",
  "status_code": 400
}

{
  "message": "<string>",
  "status_code": 401
}

{
  "message": "<string>",
  "status_code": 403
}

{
  "message": "<string>",
  "status_code": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

POST

tab

curl --request POST \
  --url https://api.us.cr4ce.com/tab \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "form": "GhIjKlMn",
  "type": "fields",
  "translated": {
    "name": {
      "en_GB": "About you"
    }
  },
  "order": 20,
  "category_option": "select",
  "categories": [
    "KlMnOpQr"
  ],
  "visible_to_applicants": true,
  "tab_divider_on_pdfs": true
}
'

{
  "categories": [
    {
      "slug": "KlMnOpQr",
      "link": "https://api.au.cr4ce.com/category/KlMnOpQr",
      "name": {
        "en_GB": "Documentary"
      }
    }
  ],
  "category_option": "select",
  "content_block": null,
  "created": "2024-12-12T09:41:21Z",
  "field_count": 6,
  "form": "GhIjKlMn",
  "locked": false,
  "name": {
    "en_GB": "About you"
  },
  "order": 20,
  "resource": "applications",
  "season": {
    "slug": "EfGhIjKl",
    "link": "https://api.au.cr4ce.com/season/EfGhIjKl",
    "name": {
      "en_GB": "2026"
    }
  },
  "settings": null,
  "slug": "StUvWxYz",
  "tab_divider_on_pdfs": true,
  "type": "fields",
  "updated": "2026-04-13T13:45:50Z",
  "visible_to_applicants": true
}

{
  "message": "<string>",
  "status_code": 400
}

{
  "message": "<string>",
  "status_code": 401
}

{
  "message": "<string>",
  "status_code": 403
}

{
  "message": "<string>",
  "status_code": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

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

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

Body

application/json

Tab creation payload.

form

string

required

Slug of the form the tab belongs to.

The form determines the season of the tab, so you do not send a season. The form must belong to a season that is not archived.

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

type

enum<string>

required

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

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.

Send the value in lower case, exactly as GET tab/{tabSlug} returns it. You cannot change the type after you create the tab.

A details tab cannot be created: one is set up with the account, the season and the form, and it is the locked tab every form already holds. referees requires the review flow feature and eligibility requires the eligibility feature, so either is rejected when the account does not have it.

Available options:

attachments,

contributors,

fields,

eligibility,

referees

translated

object

required

Translated tab values keyed by field name.

Show child attributes

Response

Tab created.

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

Example:

{
  "allowed_file_types": {
    "images": ["jpg", "png"],
    "video": ["mp4"]
  },
  "accept_attachment_links": false,
  "min_attachments": 1,
  "max_attachments": 10,
  "min_filesize": null,
  "max_filesize": 25,
  "min_video_length": null,
  "max_video_length": 120,
  "image_dimension_constraints": {
    "min_width": 800,
    "max_width": 4000,
    "min_height": 600,
    "max_height": 4000
  }
}

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.