> ## Documentation Index
> Fetch the complete documentation index at: https://docs.awardforce.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve fields
> Retrieves fields.
## OpenAPI
````yaml /api-reference/openapi-v2_3.yaml get /field
openapi: 3.1.0
info:
title: Award Force API
version: '2.3'
description: >
The Award Force API enables you to programmatically manage awards,
competitions, scholarships, and recognition programs.
Use this API to:
- Create and manage entries and submissions
- Automate judging workflows and assignments
- Process entry fees and payments
- Generate reports and analytics
- Integrate with external systems via webhooks
All API requests require authentication using an API key provided in the
`X-Api-Key` header.
license:
name: Creative Force Client Subscription Terms
url: https://creativeforce.team/agreement/
servers:
- url: https://api.us.cr4ce.com
description: US regional endpoint
- url: https://api.eu.cr4ce.com
description: EU regional endpoint
- url: https://api.au.cr4ce.com
description: Australasia regional endpoint
- url: https://api.ca.cr4ce.com
description: Canada regional endpoint
- url: https://api.hk.cr4ce.com
description: Hong Kong regional endpoint
security:
- ApiKeyAuth: []
tags:
- name: Account
description: >-
Use this operation to retrieve information about your organization
account.
The account resource provides metadata about the tenant associated with
your API key.
Note: Account information is read-only and contains organization-level
settings and identifiers.
- name: Assignments
description: >-
Use these operations to manage judging assignments for evaluating entries.
Assignments connect judges (or roles) with entries and score sets to
facilitate the review process.
Assignments can be created individually or in bulk (asynchronous
operations).
Each assignment tracks completion status, scores, and panel membership.
Assignments enable structured evaluation workflows with configurable score
sets.
- name: Attachments
description: >-
Use these operations to manage files uploaded to entries through
attachment tabs.
Attachments are distinct from field-based file uploads and allow for
supplementary materials.
Each attachment can have its own metadata and custom fields for
categorization.
Attachments remain associated with their entry throughout the entry
lifecycle.
- name: Categories
description: >-
Use these operations to manage competition categories or award divisions.
Categories organize entries into logical groups and can be hierarchical
with parent-child relationships.
Each category can have its own entry form, chapter availability, entry
limits, and custom labels.
Categories support translated names and descriptions for multi-language
programs.
- name: Chapters
description: >-
Use these operations to manage geographic or organizational divisions
within your programs.
Chapters enable you to run regional competitions, manage local awards, or
organize by business units.
Entries can be assigned to chapters, and chapters can have their own
administrators and configurations.
Chapters support translated names and custom images for branding.
- name: Contributors
description: >-
Use these operations to manage additional people associated with entries
beyond the primary entrant.
Contributors represent team members, collaborators, or co-authors on a
submission.
Each contributor can have their own custom fields and data collection
requirements.
Contributors are organized by tabs and can be managed independently from
the main entry.
- name: Documents
description: >-
Use these operations to generate and retrieve PDF documents and data
exports.
Documents can be created based on entry data, user data, or other program
information.
Document generation is asynchronous - after creating a document, poll the
endpoint to check when generation is complete.
Generated documents are available for download and can be associated with
specific entrants or entries.
- name: Entries
description: >-
Use these operations to manage entries (submissions) to your awards,
competitions, or recognition programs.
Entries are the core entity that flows through the entire lifecycle from
submission to judging to winner selection.
Entries can contain custom form fields, file uploads, contributors, and be
organized by categories and chapters.
Each entry goes through various statuses including draft, submitted, under
review, and finalist stages.
- name: Entries (realtime)
description: >-
Use these operations to perform granular updates on entries without
replacing the entire resource.
These endpoints enable real-time updates to specific entry properties such
as:
title, category assignment, chapter assignment, individual field values,
file uploads, tags, and recusal status.
These operations are optimized for interactive programs that need to
update entries incrementally.
- name: Fields
description: >-
Use these operations to manage custom form fields used to collect data
throughout your programs.
Fields can be attached to entries, users, contributors, attachments, and
other resources.
Supported field types include text, textarea, select, multi-select, date,
file upload, table, and more.
Fields support conditional logic, validation rules, and different
protection levels.
Note: Field deletion and updates are managed through the Award Force
interface.
- name: Files
description: >-
Use these operations to retrieve information about uploaded files.
Files provide metadata and download links for content uploaded throughout
the system.
Access files using their secure token identifiers.
Note: Files are read-only via this endpoint - file uploads are handled
through resource-specific upload endpoints.
- name: Leaderboard
description: >-
Use these operations to retrieve ranking results and scores for entries.
The leaderboard shows how entries rank based on score sets, with support
for filtering by category, chapter, and tags.
Results can be filtered to show specific subsets of the competition.
Note: The leaderboard is read-only and reflects calculated results from
the judging process.
- name: Orders
description: >-
Use these operations to manage payment transactions for entry fees and
other charges.
Orders represent financial transactions processed through your program.
Each order contains line items, tracks payment status, and can operate in
test or live mode.
Orders are associated with seasons and can be queried for financial
reporting.
- name: Review tasks
description: >-
Use these operations to manage individual review and evaluation
activities.
Review tasks represent specific actions that judges or administrators need
to complete during the evaluation process.
Tasks track timestamps, decisions, and judge associations.
Review tasks integrate with the broader judging workflow and status
tracking.
- name: Rounds
description: >-
Use these operations to retrieve round information for your programs.
Rounds represent phases within a season, such as entry rounds, judging
rounds, or finalist rounds.
Each round has specific start and end dates, associated forms, and can be
scoped to specific chapters.
Note: Rounds are read-only via the API and must be managed through the
Award Force interface.
- name: Score sets
description: >-
Use these operations to retrieve score set configurations and evaluation
criteria.
Score sets define the questions, scales, and calculation methods used to
evaluate entries.
Score sets can operate in different modes including judging, ranking, and
decision-making.
Note: Score sets are read-only via the API and must be configured through
the Award Force interface.
- name: Seasons
description: >-
Use these operations to retrieve information about seasons (program
cycles).
A season represents a time-bound program instance, such as "2026 Awards"
or "Q1 2026 Scholarship Round".
Seasons contain forms, rounds, categories, and chapters.
Seasons progress through statuses: draft, active, archived, and destroyed.
Note: Seasons are read-only via the API and must be managed through the
Award Force interface.
- name: Taxes
description: >-
Use these operations to retrieve tax configurations for financial
transactions.
Tax settings define how taxes are calculated and applied to orders and
payments.
Note: Tax configurations are read-only via the API and must be managed
through the Award Force interface.
- name: Users
description: >-
Use these operations to manage user accounts in your organization.
Users represent people who interact with your programs, including
entrants, judges, administrators, and other roles.
Users can be assigned roles, have custom profile fields, receive
notifications, and authenticate via API tokens.
Each user has a unique slug identifier and can participate across multiple
seasons.
- name: Webhooks
description: >-
Use these operations to manage webhook subscriptions for real-time event
notifications.
Webhooks notify your external systems when events occur in Award Force,
such as entry submissions, status changes, or payment completions.
Available events include: entry created, entry submitted, entry status
changed, payment success, user confirmed, and 20+ more.
Configure webhooks to send HTTP POST requests to your specified URLs with
event payloads.
paths:
/field:
get:
tags:
- Fields
summary: Retrieve fields
description: Retrieves fields.
operationId: GetFieldCollectionV23
parameters:
- $ref: '#/components/parameters/fieldConditionalFilter'
- $ref: '#/components/parameters/fieldProtectionFilter'
- $ref: '#/components/parameters/fieldResourceFilter'
- $ref: '#/components/parameters/fieldTypeFilter'
- $ref: '#/components/parameters/categoryFilter'
- $ref: '#/components/parameters/formFilter'
- $ref: '#/components/parameters/tabFilter'
- $ref: '#/components/parameters/seasonFilter'
- $ref: '#/components/parameters/deletedFilter'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/perPage'
- $ref: '#/components/parameters/fieldOrder'
- $ref: '#/components/parameters/sortDirection'
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/X-Api-Language'
responses:
'200':
description: Fields retrieved.
headers:
ETag:
$ref: '#/components/headers/ETag'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/FieldList'
application/xml:
schema:
$ref: '#/components/schemas/FieldList'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
'503':
$ref: '#/components/responses/ServiceUnavailable'
components:
parameters:
fieldConditionalFilter:
name: conditional
in: query
required: false
description: Filter by conditional value.
schema:
type: string
fieldProtectionFilter:
name: protection
in: query
required: false
description: Filter by protection level.
schema:
type: string
enum:
- standard
- elevated
- maximum
fieldResourceFilter:
name: resource
in: query
required: false
description: Filter by resource type.
schema:
type: string
enum:
- entries
- users
- attachments
- contributors
fieldTypeFilter:
name: type
in: query
required: false
description: Filter by field type.
schema:
type: string
enum:
- checkbox
- checkboxlist
- content
- country
- currency
- date
- datetime
- drop-down-list
- email
- file
- numeric
- phone
- radio
- table
- text
- textarea
- time
- url
categoryFilter:
name: category
in: query
required: false
description: Filter by category slug.
schema:
type: string
formFilter:
name: form
in: query
required: false
description: >-
Filter by form slug.
Use the value `all` to include results from every form rather than a
single form.
schema:
type: string
tabFilter:
name: tab
in: query
required: false
description: Filter by tab slug.
schema:
type: string
seasonFilter:
name: season
in: query
required: false
description: |-
Filter by season slug.
Use `all` to show all seasons.
schema:
type: string
deletedFilter:
name: deleted
in: query
required: false
description: |-
Filter by deletion mode.
* `only` - Show only deleted resources.
* `included` - Include deleted resources.
* `none` - Exclude deleted resources.
schema:
type: string
enum:
- only
- included
- none
page:
name: page
in: query
required: false
description: Specify the page number to return.
schema:
type: number
perPage:
name: per_page
in: query
required: false
description: >
Limit the number of items returned to between 1 and 100.
If you provide a value outside this range, you will receive a `400`
response.
schema:
type: number
fieldOrder:
name: order
in: query
required: false
description: Sort by a supported field property.
schema:
type: string
enum:
- title
- resource
- type
- updated
- created
- categories
- order
- tab
- form
- auto_scoring
- category_count
sortDirection:
name: dir
in: query
required: false
description: >-
Sort in ascending or descending order. Invalid values are rejected with
`400 Bad Request`.
schema:
type: string
enum:
- asc
- desc
Accept:
name: Accept
in: header
required: true
description: Defines the response type.
schema:
type: string
enum:
- application/vnd.Creative Force.v2.3+json
- application/vnd.Creative Force.v2.3+xml
X-Api-Language:
name: x-api-language
in: header
required: false
description: >-
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.
style: simple
explode: false
schema:
type: array
items:
type: string
enum:
- all
- ar_AR
- bg_BG
- bn_IN
- ca_ES
- cs_CZ
- cy_GB
- da_DK
- de_DE
- en_GB
- en_US
- el_GR
- es_NN
- es_LA
- et_EE
- fa_NN
- fi_FI
- fr_FR
- fr_CA
- he_IL
- hi_IN
- hr_HR
- hu_HU
- hy_AM
- it_IT
- ja_JP
- ko_KR
- lt_LT
- ms_MY
- nl_NL
- nb_NO
- pl_PL
- pt_BR
- ro_RO
- ru_RU
- sk_SK
- sl_SI
- sq_AL
- sr_RS
- sv_SE
- sw_NN
- th_TH
- tr_TR
- uk_UA
- vi_VN
- zh_CN
- zh_HK
example:
- en_GB
- fr_FR
headers:
ETag:
description: Entity tag for the selected representation.
schema:
type: string
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
schema:
type: integer
example: 60
X-RateLimit-Remaining:
description: Number of requests remaining in the current rate limit window.
schema:
type: integer
example: 58
X-RateLimit-Reset:
description: Unix timestamp when the rate limit window resets.
schema:
type: integer
example: 1783470988
Retry-After:
description: Number of seconds the client should wait before retrying.
schema:
type: integer
example: 60
schemas:
FieldList:
allOf:
- $ref: '#/components/schemas/Pagination'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Field'
example:
current_page: 1
data:
- entrant_read_access: true
entrant_write_access: true
auto_scoring: 0
categories:
- '*'
category_count: all
conditional_field: null
created: '2025-01-15T09:00:00Z'
file_types: []
form:
slug: GhIjKlMn
link: https://api.au.cr4ce.com/form/GhIjKlMn
name:
en_GB: Entry form
help_text:
en_GB: Provide a concise summary of your work.
hint_text:
en_GB: Up to 500 words.
label:
en_GB: Summary
max_file_size: null
maximum_characters: null
maximum_words: 500
minimum_characters: null
minimum_words: null
options: []
order: 1
protection: standard
registration: null
required: true
resource: entries
searchable: true
season:
slug: QrStUvWx
link: https://api.au.cr4ce.com/season/QrStUvWx
name:
en_GB: '2025'
slug: AbCdEfGh
tab:
slug: StUvWxYz
link: https://api.au.cr4ce.com/tab/StUvWxYz
name:
en_GB: About you
title:
en_GB: Summary
type: textarea
updated: '2025-06-20T14:30:00Z'
visibility:
- qualifying
- vip_judging
first_page_url: https://api.au.cr4ce.com/field?per_page=10&page=1
from: 1
last_page: 2
last_page_url: https://api.au.cr4ce.com/field?per_page=10&page=2
next_page_url: https://api.au.cr4ce.com/field?per_page=10&page=2
path: https://api.au.cr4ce.com/field
per_page: 10
prev_page_url: ''
to: 10
total: 12
Pagination:
type: object
title: Pagination
description: >-
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.
properties:
current_page:
type: integer
description: Number of the page returned by this response. The first page is `1`.
first_page_url:
type: string
description: >-
URL of the first page in the result set. Relative when the requested
page is beyond the last page.
from:
type:
- integer
- 'null'
description: >-
Position of the first record on this page within the full result
set. The first record is at position `1`. `null` when the requested
page is beyond the last page.
last_page:
type: integer
description: Number of the last page. Equals the total number of pages.
last_page_url:
type: string
description: >-
URL of the last page in the result set. Relative when the requested
page is beyond the last page.
next_page_url:
type: string
description: |-
URL of the next page in the result set.
Empty string when the current page is the last page.
path:
type: string
description: Canonical URL of the endpoint, without query parameters.
per_page:
type: integer
minimum: 1
maximum: 100
default: 10
description: Maximum number of records returned per page.
prev_page_url:
type: string
description: |-
URL of the previous page in the result set.
Empty string when the current page is the first page.
to:
type:
- integer
- 'null'
description: >-
Position of the last record on this page within the full result set.
`null` when the requested page is beyond the last page.
total:
type: integer
description: Total number of records across all pages.
Field:
type: object
properties:
entrant_read_access:
type: boolean
description: Whether entrants can view this field.
entrant_write_access:
type: boolean
description: Whether entrants can edit this field.
auto_scoring:
type: integer
description: >-
Score awarded automatically for the field, or `0` when automatic
judging is not configured.
categories:
type: array
description: >-
Category slugs the field is associated with. The single-element
array `["*"]` indicates the field applies to every category.
items:
type: string
category_count:
description: >-
Number of categories the field is associated with. The string `all`
indicates the field applies to every category (paired with
`categories` of `["*"]`). `null` when the field is not
category-scoped.
conditional_field:
type:
- object
- 'null'
description: >-
Field whose value controls whether this field is shown, or `null`
when the field is not conditional.
properties:
slug:
type: string
description: Short URL-safe identifier for the controlling field.
link:
type: string
format: uri
description: Canonical URL for the controlling field resource.
name:
type: object
description: >-
Display name of the controlling field.
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.
additionalProperties:
type: string
created:
type: string
format: date-time
description: Date and time when the field was created.
file_types:
type: array
description: >-
Permitted file extensions for file fields. Empty when the field does
not accept file uploads or no restriction applies.
items:
type: string
form:
type:
- object
- 'null'
description: >-
Form the field belongs to, or `null` when the field is not attached
to a form.
properties:
slug:
type: string
description: Short URL-safe identifier for the form.
link:
type: string
format: uri
description: Canonical URL for the form resource.
name:
type: object
description: >-
Display name of the form.
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.
additionalProperties:
type: string
help_text:
type: object
description: >-
Help text shown for the field, 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.
additionalProperties:
type: string
hint_text:
type: object
description: >-
Hint text shown for the field, 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.
additionalProperties:
type: string
label:
type: object
description: >-
Label of the field, 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.
additionalProperties:
type: string
max_file_size:
type:
- integer
- 'null'
description: >-
Maximum upload size in megabytes for file fields, or `null` when no
limit applies.
maximum_characters:
type:
- integer
- 'null'
description: >-
Maximum number of characters accepted, or `null` when no limit
applies.
maximum_words:
type:
- integer
- 'null'
description: Maximum number of words accepted, or `null` when no limit applies.
minimum_characters:
type:
- integer
- 'null'
description: >-
Minimum number of characters required, or `null` when no limit
applies.
minimum_words:
type:
- integer
- 'null'
description: Minimum number of words required, or `null` when no limit applies.
options:
type: array
description: >-
Selectable options for choice fields (for example, drop-down or
radio). Empty when the field type has no options.
items:
type: string
order:
type: integer
description: Position of the field within its tab, used for ordering.
protection:
type: string
description: >-
Protection level governing access to the data for the field (for
example, `standard`, `elevated`, or `maximum`).
registration:
type:
- string
- 'null'
description: >-
Registration attribute the field is mapped to, or `null` when the
field is not mapped to a registration attribute.
required:
type: boolean
description: Whether a value is required for the field.
resource:
type: string
description: >-
Resource the field collects data for (for example, the entry or
application, `contributors`, `referees`, `attachments`, or `users`).
searchable:
type: boolean
description: Whether the field is included in search.
season:
type: object
description: Season the field belongs to.
properties:
slug:
type: string
description: Short URL-safe identifier for the season.
link:
type: string
format: uri
description: Canonical URL for the season resource.
name:
type: object
description: >-
Display 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.
additionalProperties:
type: string
slug:
type: string
description: Short URL-safe identifier for the field.
tab:
type:
- object
- 'null'
description: >-
Tab the field belongs to, or `null` when the field is not attached
to a tab.
properties:
slug:
type: string
description: Short URL-safe identifier for the tab.
link:
type: string
format: uri
description: Canonical URL for the tab resource.
name:
type: object
description: >-
Display name of the tab.
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.
additionalProperties:
type: string
title:
type: object
description: >-
Plain-text title of the field.
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.
additionalProperties:
type: string
type:
type: string
description: >-
Field type (for example, `text`, `textarea`, `drop-down-list`,
`file`, `currency`, or `date`).
updated:
type: string
format: date-time
description: Date and time when the field was last updated.
visibility:
type: array
description: >-
Contexts in which the field is visible (for example, `qualifying`,
`top_pick`, `voting`, `gallery`, or `vip_judging`).
items:
type: string
example:
entrant_read_access: true
entrant_write_access: true
auto_scoring: 0
categories:
- '*'
category_count: all
conditional_field: null
created: '2025-01-15T09:00:00Z'
file_types: []
form:
slug: GhIjKlMn
link: https://api.au.cr4ce.com/form/GhIjKlMn
name:
en_GB: Entry form
help_text:
en_GB: Provide a concise summary of your work.
hint_text:
en_GB: Up to 500 words.
label:
en_GB: Summary
max_file_size: null
maximum_characters: null
maximum_words: 500
minimum_characters: null
minimum_words: null
options: []
order: 1
protection: standard
registration: null
required: true
resource: entries
searchable: true
season:
slug: QrStUvWx
link: https://api.au.cr4ce.com/season/QrStUvWx
name:
en_GB: '2025'
slug: AbCdEfGh
tab:
slug: StUvWxYz
link: https://api.au.cr4ce.com/tab/StUvWxYz
name:
en_GB: About you
title:
en_GB: Summary
type: textarea
updated: '2025-06-20T14:30:00Z'
visibility:
- qualifying
- vip_judging
BadRequest:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 400
maximum: 400
Unauthorized:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 401
maximum: 401
Forbidden:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 403
maximum: 403
TooManyRequests:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 429
maximum: 429
BaseProblem:
description: Standard error envelope shared by every error response on this API.
type: object
properties:
message:
type: string
status_code:
type: integer
minimum: 400
maximum: 599
responses:
BadRequest:
description: >-
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.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
application/xml:
schema:
$ref: '#/components/schemas/BadRequest'
Unauthorized:
description: Missing `x-api-key` header.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/xml:
schema:
$ref: '#/components/schemas/Unauthorized'
Forbidden:
description: |-
Authenticated request denied. Common causes: invalid or unknown
API key, suspended account, or `api` feature not enabled for
the account.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
application/xml:
schema:
$ref: '#/components/schemas/Forbidden'
TooManyRequests:
description: Rate limit of 60 requests per minute exceeded.
headers:
Retry-After:
$ref: '#/components/headers/Retry-After'
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/xml:
schema:
$ref: '#/components/schemas/TooManyRequests'
ServiceUnavailable:
description: Service is temporarily unavailable due to regional maintenance.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Human-readable maintenance status.
example:
status: Maintenance in progress
application/xml:
schema:
type: object
properties:
status:
type: string
description: Human-readable maintenance status.
example:
status: Maintenance in progress
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: |-
API key used to authenticate and authorise every request.
Include it in the `x-api-key` header.
````