---
title: "Retrieve a document"
method: GET
path: "/document/{document_slug}"
tags: ["Documents"]
---

# Retrieve a document

`GET /document/{document_slug}`

Retrieves the document identified by the specified slug.

## Path parameters

- `document_slug` string, required

## Headers

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

## Response `200`

Document retrieved.

- Document — Document generated from a document template and attached to an entry, allocation, or user. Carries the generated file, its translated name and description, the user who created it, and the resource it is attached to.
  - `allocation` object — Allocation the document is attached to. Empty array when the document is not attached to an allocation.
    - `slug` string — Short URL-safe identifier for the allocation.
    - `link` string, uri — Canonical URL for the allocation resource.
  - `created_at` string, date-time — Date and time when the document was created.
  - `description` object — Description of the document, inherited from the document template. 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.
  - `entry` object — Entry the document is attached to. Empty array when the document is not attached to an entry.
    - `slug` string — Short URL-safe identifier for the entry.
    - `link` string, uri — Canonical URL for the entry resource.
    - `title` string — Title of the entry.
  - `file` object — Generated document file.
    - `token` string — Token identifying the file.
    - `link` string, uri — Canonical URL for the file resource.
    - `name` string — Original filename of the generated document.
    - `download` string, uri — Time-limited download URL for the file.
  - `file_type` 'PDF' | 'Word' — File format of the generated document.
  - `name` object — Name of the document. 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.
  - `shared_with_user` boolean — Specifies whether the document is shared with the entrant.
  - `slug` string — URL-safe identifier of the document.
  - `user` object — User who created the document. Empty array when no user is attached.
    - `slug` string — Short URL-safe identifier for the user.
    - `link` string, uri — Canonical URL for the user resource.
    - `name` string — Full name of the user.
    - `first_name` string — First name of the user.
    - `last_name` string — Last name of the user.

## 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.
- `404` — Resource identified by the path slug does not exist. Returned when the slug is well-formed but no record matches it.
- `429` — Rate limit of 60 requests per minute exceeded.
- `503` — Service is temporarily unavailable due to regional maintenance.

## Changes

- **2026-07-07** (v2) `9b9103538ceb` — 2 info
  - api tag `Documents` added
  - api tag `Document` removed
- **2026-07-01** (v2) `e96a96d4507e` — 7 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`
  - …3 more
- **2026-06-30** (v2) `1d2a0b158b9c` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/tectonic/apis/award-force-api/changes/document/:document_slug/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/e2511e46f9f2/schema)