Sign in
Documents

Retrieve documents

Retrieves documents.

get/document

Query parameters

entrantstring

Filter by entrant slug.

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

Filter by deletion mode.

  • only - Show only deleted resources.
  • included - Include deleted resources.
  • none - Exclude deleted resources.
trashed'only' | 'all' | 'none'

Filter by soft-deletion mode.

  • only - Show only soft-deleted resources.
  • all - Include soft-deleted resources alongside live ones.
  • none - Exclude soft-deleted resources.
pagestring

Specify the page number to return.

per_pagestring

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

order'created_at' | 'file' | 'file_type' | 'name' | 'shared_with_user' | 'updated_at'

Column to sort by.

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

Documents 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": [
    {
      "allocation": [],
      "created_at": "2025-01-15T09:00:00Z",
      "description": {
        "en_GB": ""
      },
      "entry": {
        "slug": "AbCdEfGh",
        "link": "https://api.au.cr4ce.com/entry/AbCdEfGh",
        "title": "Sustainable Cities Initiative"
      },
      "file": {
        "token": "IjKlMnOpQrStUvWx",
        "link": "https://api.au.cr4ce.com/file/IjKlMnOpQrStUvWx",
        "name": "certificate.pdf",
        "download": "https://files.au.cr4ce.com/file/IjKlMnOpQrStUvWx/certificate.pdf?Expires=1781485359&Signature=REDACTED&Key-Pair-Id=REDACTED"
      },
      "file_type": "PDF",
      "name": {
        "en_GB": "Certificate of entry"
      },
      "shared_with_user": false,
      "slug": "QrStUvWx",
      "user": {
        "slug": "YzAbCdEf",
        "link": "https://api.au.cr4ce.com/user/YzAbCdEf",
        "name": "Rachel Martin",
        "first_name": "Rachel",
        "last_name": "Martin"
      }
    },
    {
      "allocation": {
        "slug": "KlMnOpQr",
        "link": "https://api.au.cr4ce.com/allocation/KlMnOpQr"
      },
      "created_at": "2025-02-10T10:00:00Z",
      "description": {
        "en_GB": ""
      },
      "entry": [],
      "file": {
        "token": "StUvWxYzAbCdEfGh",
        "link": "https://api.au.cr4ce.com/file/StUvWxYzAbCdEfGh",
        "name": "grant-report.pdf",
        "download": "https://files.au.cr4ce.com/file/StUvWxYzAbCdEfGh/grant-report.pdf?Expires=1781485359&Signature=REDACTED&Key-Pair-Id=REDACTED"
      },
      "file_type": "Word",
      "name": {
        "en_GB": "Grant report"
      },
      "shared_with_user": true,
      "slug": "WxYzAbCd",
      "user": {
        "slug": "YzAbCdEf",
        "link": "https://api.au.cr4ce.com/user/YzAbCdEf",
        "name": "Rachel Martin",
        "first_name": "Rachel",
        "last_name": "Martin"
      }
    }
  ],
  "first_page_url": "https://api.au.cr4ce.com/document?per_page=10&page=1",
  "from": 1,
  "last_page": 4,
  "last_page_url": "https://api.au.cr4ce.com/document?per_page=10&page=4",
  "next_page_url": "https://api.au.cr4ce.com/document?per_page=10&page=2",
  "path": "https://api.au.cr4ce.com/document",
  "per_page": 10,
  "prev_page_url": "",
  "to": 10,
  "total": 38
}

Changes