v50

latestOpenAPI 3.1.0Creative Force Client Subscription Termsraw.githubusercontent.com2026-07-137852387.4 KB

Retrieve a category

Retrieves the category identified by the specified slug.

get/category/{category_slug}

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

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.

Response

Category retrieved.

createdstring date-time

Date and time when the category was created.

descriptionobject

Description shown to entrants on the category, as an HTML fragment.

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.

divisionsinteger

Number of divisions configured for the category. Always at least 1.

nameobject

Display name of the category.

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.

promoted0 | 1 | null nullable

Promotion state of the category.

1 when promoted, 0 when not, and null when no preference has been set.

shortcodeobject

Short code used to reference the category.

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.

slugstring

Short URL-safe identifier for the category.

status'active' | 'inactive'

Current state of the category.

updatedstring date-time

Date and time when the category was last updated.

entrant_max_entriesinteger nullable

Maximum number of entries a single entrant may submit to this category.

null when the number of entries is not capped.

entry_name_labelobject

Custom label for the entry-name field shown to entrants.

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.

fill_entry_nameboolean

Specifies whether entrants are asked to name their entry when submitting to this category.

image_headingobject

Heading shown above the category images.

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.

max_image_widthinteger

Maximum display width for the category images, in pixels.

packing_slip_instructionsobject

Instructions shown on the packing slip for the category.

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.

pdf_packing_slipboolean

Specifies whether a PDF packing slip is enabled for the category.

Example response

{
  "created": "2025-01-15T09:00:00Z",
  "description": {
    "en_GB": "Submit your documentary films exploring real-world subjects and stories."
  },
  "divisions": 1,
  "form": {
    "slug": "GhIjKlMn",
    "link": "https://api.au.cr4ce.com/form/GhIjKlMn",
    "name": {
      "en_GB": "Entry form"
    }
  },
  "name": {
    "en_GB": "Documentary"
  },
  "parent": {
    "slug": "KlMnOpQr",
    "link": "https://api.au.cr4ce.com/category/KlMnOpQr",
    "name": {
      "en_GB": "Film"
    }
  },
  "promoted": null,
  "season": {
    "slug": "QrStUvWx",
    "link": "https://api.au.cr4ce.com/season/QrStUvWx",
    "name": {
      "en_GB": "2025"
    }
  },
  "shortcode": {
    "en_GB": "01"
  },
  "slug": "AbCdEfGh",
  "status": "active",
  "updated": "2025-06-20T14:30:00Z",
  "chapters": [
    {
      "slug": "MnOpQrSt",
      "link": "https://api.au.cr4ce.com/chapter/MnOpQrSt",
      "name": {
        "en_GB": "Film"
      }
    }
  ],
  "entrant_max_entries": null,
  "entry_name_label": {
    "en_GB": "Entry title"
  },
  "fill_entry_name": false,
  "image_heading": {
    "en_GB": "Category image"
  },
  "images": [
    {
      "token": "AbCdEfGhIjKlMnOp",
      "link": "https://api.au.cr4ce.com/file/AbCdEfGhIjKlMnOp",
      "filename": "example.png",
      "download": "https://files.au.cr4ce.com/file/AbCdEfGhIjKlMnOp/example.png?Expires=1781657570&Signature=REDACTED&Key-Pair-Id=REDACTED"
    }
  ],
  "max_image_width": 300,
  "packing_slip_instructions": {
    "en_GB": "Attach this slip to each physical submission."
  },
  "pdf_packing_slip": false
}