Sign in
Categories

Retrieve categories

Retrieves categories.

get/category

Query parameters

status'active' | 'inactive'

Filter by status.

chapterstring

Filter by chapter slug.

formstring

Filter by form slug.

Use the value all to include results from every form rather than a single form.

parentstring

Filter by parent category slug.

seasonstring

Filter by season slug. Use all to show all seasons.

deleted'only' | 'included' | 'none'

Filter by deletion mode.

  • only - Show only deleted resources.
  • included - Include deleted resources.
  • none - Exclude deleted resources.
pagestring

Specify the page number to return.

per_pagestring

Limit the number of items returned to between 1 and 100.

order'chapter_count' | 'created' | 'divisions' | 'entry_count' | 'form' | 'name' | 'parent' | 'promoted' | 'season' | 'shortcode' | 'status' | 'updated'

Sort by a supported category field.

  • parent - Sort by parent slug.
  • season - Sort by season slug.
dir'asc' | 'desc'

Sort in ascending or descending order.

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 omitted, the account default language is used.

Value all overrides any other values present.

Response

Categories retrieved.

current_pageinteger

Number of the page returned by this response. The first page is 1.

first_page_urlstring uri

URL of the first page in the result set.

frominteger

Position of the first record on this page within the full result set. The first record is at position 1.

last_pageinteger

Number of the last page. Equals the total number of pages.

last_page_urlstring uri

URL of the last page in the result set.

next_page_urlstring

URL of the next page in the result set.

Empty string when the current page is the last page.

pathstring uri

Canonical URL of the endpoint, without query parameters.

per_pageinteger

Maximum number of records returned per page.

prev_page_urlstring

URL of the previous page in the result set.

Empty string when the current page is the first page.

tointeger

Position of the last record on this page within the full result set.

totalinteger

Total number of records across all pages.

Example response

{
  "current_page": 1,
  "data": [
    {
      "created": "2024-05-23T13:37:43Z",
      "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": null,
      "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-05-07T16:18:07Z",
      "chapter_count": 4,
      "entry_count": 3
    },
    {
      "created": "2025-02-10T10:00:00Z",
      "description": {
        "en_GB": "Submit short films under 40 minutes in length."
      },
      "divisions": 1,
      "form": {
        "slug": "GhIjKlMn",
        "link": "https://api.au.cr4ce.com/form/GhIjKlMn",
        "name": {
          "en_GB": "Entry form"
        }
      },
      "name": {
        "en_GB": "Short Film"
      },
      "parent": {
        "slug": "KlMnOpQr",
        "link": "https://api.au.cr4ce.com/category/KlMnOpQr",
        "name": {
          "en_GB": "Film"
        }
      },
      "promoted": 1,
      "season": {
        "slug": "QrStUvWx",
        "link": "https://api.au.cr4ce.com/season/QrStUvWx",
        "name": {
          "en_GB": "2025"
        }
      },
      "shortcode": {
        "en_GB": "02"
      },
      "slug": "WxYzAbCd",
      "status": "active",
      "updated": "2025-02-10T10:05:00Z",
      "chapter_count": 2,
      "entry_count": 0
    }
  ],
  "first_page_url": "https://api.au.cr4ce.com/category?per_page=10&page=1",
  "from": 1,
  "last_page": 7,
  "last_page_url": "https://api.au.cr4ce.com/category?per_page=10&page=7",
  "next_page_url": "https://api.au.cr4ce.com/category?per_page=10&page=2",
  "path": "https://api.au.cr4ce.com/category",
  "per_page": 10,
  "prev_page_url": "",
  "to": 10,
  "total": 66
}

Changes