---
title: "Retrieve allocations"
method: GET
path: "/allocation"
tags: ["Allocation"]
---

# Retrieve allocations

`GET /allocation`

Retrieves allocations.

## Query parameters

- `trashed` 'only' | 'all' | 'none'
- `order` 'amount' | 'created' | 'currency' | 'paid' | 'slug' | 'updated'
- `dir` 'asc' | 'desc'
- `page` string
- `per_page` string

## Headers

- `Accept` 'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml', required
- `x-api-language` string[]

## Response `200`

Allocations retrieved.

- AllocationList — Pagination envelope returned by every list endpoint. Wraps the result set with positional fields (`current_page`, `from`, `to`, `total`) and navigation URLs (`first_page_url`, `last_page_url`, `next_page_url`, `prev_page_url`) for traversing the full list. The records themselves are returned in a sibling `data` array supplied by the wrapping schema.
  - `current_page` integer — Number of the page returned by this response. The first page is `1`.
  - `first_page_url` string, uri — URL of the first page in the result set.
  - `from` integer — Position of the first record on this page within the full result set. The first record is at position `1`.
  - `last_page` integer — Number of the last page. Equals the total number of pages.
  - `last_page_url` string, uri — URL of the last page in the result set.
  - `next_page_url` string — URL of the next page in the result set. Empty string when the current page is the last page.
  - `path` string, uri — Canonical URL of the endpoint, without query parameters.
  - `per_page` integer — Maximum number of records returned per page.
  - `prev_page_url` string — URL of the previous page in the result set. Empty string when the current page is the first page.
  - `to` integer — Position of the last record on this page within the full result set.
  - `total` integer — Total number of records across all pages.
  - `data` Allocation[]
    - `amount` number — Total amount allocated to the entry from the fund, in the fund's currency.
    - `chapter` object — Chapter the entry belongs to. Emitted as an empty array when the entry has no chapter.
      - `slug` string — URL-safe identifier of the chapter.
      - `link` string, uri — Canonical URL of the chapter resource.
      - `name` object — Name of the chapter. 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.
    - `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.
    - `entrant` object, nullable — Entrant who owns the entry the allocation belongs to. Emitted as an empty array when the entry has no entrant.
      - `slug` string — URL-safe identifier of the entrant.
      - `link` string, uri — Canonical URL of the entrant resource.
      - `name` string — Full display name of the entrant.
      - `first_name` string — Given name of the entrant.
      - `last_name` string — Family name of the entrant.
    - `entry` object, nullable — Entry the allocation belongs to. Emitted as an empty array when the allocation has no associated entry.
      - `slug` string — URL-safe identifier of the entry.
      - `id` integer — Internal numeric identifier of the entry.
      - `title` string — Title of the entry as submitted by the entrant.
      - `link` string, uri — Canonical URL of the entry resource.
    - `fund` object — Fund the allocation draws from.
      - `slug` string — URL-safe identifier of the fund.
      - `link` string, uri — Canonical URL of the fund resource.
      - `name` object — Name of the fund. 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.
    - `paid` number — Outstanding amount due on the allocation, in the fund's currency, after deducting payments already made.
    - `season` object — Season the allocation belongs to.
      - `slug` string — URL-safe identifier of the season.
      - `link` string, uri — Canonical URL of the season resource.
      - `name` object — Name of the season. 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.
    - `slug` string — URL-safe identifier of the allocation.
    - `updated` string, date-time — Date and time when the allocation was last updated.

## Other responses

- `400` — Request was rejected before the endpoint could process it. Common causes: invalid `Accept` header, unsupported `x-api-language` code, empty request body on `POST` / `PUT`, invalid JSON in the request body, or an invalid slug format in a path parameter.
- `401` — Missing `x-api-key` header.
- `403` — Authenticated request denied. Common causes: invalid or unknown API key, suspended account, or `api` feature not enabled for the account.
- `429` — Rate limit of 60 requests per minute exceeded.
- `503` — Service is temporarily unavailable due to regional maintenance.

## Changes

- **2026-07-01** (v2) `e96a96d4507e` — 6 info
  - added the media type `application/xml` for the response with the status `200`
  - added the media type `application/xml` for the response with the status `400`
  - added the media type `application/xml` for the response with the status `401`
  - added the media type `application/xml` for the response with the status `403`
  - …2 more
- **2026-06-30** (v2) `8a9285045d9c` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/tectonic/apis/award-force-api/changes/allocation/get.md)

---

[API](https://skmtc.dev/tectonic/apis/award-force-api.md) · [All operations](https://skmtc.dev/tectonic/apis/award-force-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tectonic/award-force-api/revisions/e96a96d4507e/schema)
