> ## Documentation Index > Fetch the complete documentation index at: https://docs.goodgrants.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve applications > Retrieves applications. ## OpenAPI ````yaml /api-reference/openapi-v2_3.yaml get /application openapi: 3.1.0 info: title: Good Grants API version: '2.3' description: > The Good Grants API enables you to programmatically manage grant-making programs, funding cycles, and application workflows. Use this API to: - Create and manage grant applications and submissions - Automate review workflows and scoring assignments - Track grant payments and fund allocations - Generate compliance 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: Action tasks description: >- Use these operations to manage individual review and evaluation activities. Action tasks represent specific actions that reviewers or administrators need to complete during the evaluation process. Tasks track timestamps, decisions, and reviewer associations. Action tasks integrate with the broader review workflow and status tracking. - name: Allocation payments description: >- Use these operations to manage individual payments made against grant allocations. Allocation payments represent installments or disbursements of awarded funds. Payments track scheduling, status (pending, paid, cancelled), and amounts. Comments can be added to payments for grantee communication and record-keeping purposes. - name: Allocations description: >- Use these operations to manage grant allocations awarded to applications. An allocation represents the award of funds from a budget (fund) to an application or applicant. Allocations track the total grant amount, currency, and outstanding balance. Multiple payments can be made against a single allocation to facilitate installment-based grants or milestone payments. - name: Applications (realtime) description: >- Use these operations to perform granular updates on applications without replacing the entire resource. These endpoints enable real-time updates to specific application properties such as: title, category assignment, chapter assignment, individual field values, document uploads, tags, and recusal status. These operations are optimized for interactive applications that need to update grants incrementally. - name: Applications description: >- Use these operations to manage grant applications submitted to your funding programs. Applications are the core entity that flows through the entire lifecycle from submission to review to grant award. Applications can contain custom form fields, supporting documents, contributors, and be organized by categories and chapters. Each application progresses through various statuses including draft, submitted, under review, and approved stages. - name: Assignments description: >- Use these operations to manage review assignments for evaluating grant applications. Assignments connect reviewers (or roles) with applications and scoring rubrics to facilitate the evaluation process. Assignments can be created individually or in bulk (asynchronous operations). Each assignment tracks completion status, scores, and panel membership. Assignments enable structured review workflows with configurable scoring criteria. - name: Attachments description: >- Use these operations to manage files uploaded to applications through attachment tabs. Attachments are distinct from field-based file uploads and allow for supplementary materials such as letters of support or compliance documents. Each attachment can have its own metadata and custom fields for categorization. Attachments remain associated with their application throughout the application lifecycle. - name: Categories description: >- Use these operations to manage funding categories or program areas. Categories organize applications into logical groups and can be hierarchical with parent-child relationships. Each category can have its own application form, chapter availability, submission limits, and custom labels. Categories support translated names and descriptions for multi-language grant programs. - name: Chapters description: >- Use these operations to manage geographic or organizational divisions within your grant programs. Chapters enable you to run regional funding programs, manage local grants, or organize by funding priorities. Applications 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 applications beyond the primary applicant. Contributors represent project team members, fiscal sponsors, or partners on a grant proposal. 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 application. - name: Documents description: >- Use these operations to generate and retrieve PDF documents and data exports. Documents can be created based on application data, grantee data, compliance reports, 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 applicants or applications. - name: Fields description: >- Use these operations to manage custom form fields used to collect data throughout your grant programs. Fields can be attached to applications, 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 Good Grants interface. - name: Files description: >- Use these operations to retrieve information about uploaded files. Files provide metadata and download links for documents 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: Forms description: >- Use these operations to retrieve application form structures and configurations. Forms define the data collection structure for grant applications within categories. Each form contains custom fields organized into tabs, along with content blocks and call-to-action elements. Forms support various types including application forms, review forms, and nomination forms. Note: Forms are read-only via the API and must be configured through the Good Grants interface. - name: Funds description: >- Use these operations to manage budget sources for allocations and grants. Funds represent pools of money available for distribution, such as "Innovation Fund 2026" or "Community Development Budget". Each fund tracks its budget, currency, and can have multiple allocations drawn against it. Funds enable financial tracking and reporting across your grant-making programs. - name: Grant reports description: >- Use these operations to manage grant reports and post-award compliance documentation. Grant reports track progress reporting requirements and outcomes for awarded grants. Reports capture applicant information, application details, custom form fields, and status tracking. - name: Grant statuses description: >- Use these operations to retrieve custom grant lifecycle statuses. Grant statuses provide additional status tracking beyond standard application review statuses. These are used to track stages like "Eligibility Review", "Compliance Check", "Funding Approved", "Grant Agreement Signed". Note: Grant statuses are read-only via the API and must be configured through the Good Grants interface. - name: Leaderboard description: >- Use these operations to retrieve ranking results and scores for applications. The leaderboard shows how applications rank based on score sets, with support for filtering by category, chapter, and tags. Results can be filtered to show specific subsets of the funding program. Note: The leaderboard is read-only and reflects calculated results from the review process. - name: Rounds description: >- Use these operations to retrieve round information for your grant programs. Rounds represent phases within a funding cycle, such as application rounds, review rounds, or decision 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 Good Grants interface. - name: Score sets description: >- Use these operations to retrieve scoring rubrics and evaluation criteria. Score sets define the questions, scoring scales, and calculation methods used to evaluate grant applications. Score sets can operate in different modes including scoring, ranking, and decision-making. Note: Score sets are read-only via the API and must be configured through the Good Grants interface. - name: Seasons description: >- Use these operations to retrieve information about funding cycles (seasons). A season represents a time-bound grant program instance, such as "2026 Community Grants" or "Q1 2026 Innovation Fund". 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 Good Grants 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 Good Grants interface. - name: Users description: >- Use these operations to manage user accounts in your grant-making organization. Users represent people who interact with your programs, including applicants, reviewers, 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 funding cycles. - name: Webhooks description: >- Use these operations to manage webhook subscriptions for real-time event notifications. Webhooks notify your external systems when events occur in Good Grants, such as application submissions, status changes, or payment completions. Available events include: application created, application submitted, application status changed, payment success, user confirmed, and 20+ more. Configure webhooks to send HTTP POST requests to your specified URLs with event payloads. paths: /application: get: tags: - Applications summary: Retrieve applications description: Retrieves applications. operationId: GetEntryCollectionV23 parameters: - $ref: '#/components/parameters/entryEntrantFilter' - $ref: '#/components/parameters/entryModerationFilter' - $ref: '#/components/parameters/entryPaymentStatusFilter' - $ref: '#/components/parameters/entryPriceFilter' - $ref: '#/components/parameters/entryStatusFilter' - $ref: '#/components/parameters/entryTitleFilter' - $ref: '#/components/parameters/entryUpdatedAtFilter' - $ref: '#/components/parameters/categoryFilter' - $ref: '#/components/parameters/chapterFilter' - $ref: '#/components/parameters/seasonFilter' - $ref: '#/components/parameters/archivedFilter' - $ref: '#/components/parameters/deletedFilter' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/perPage' - $ref: '#/components/parameters/entryOrder' - $ref: '#/components/parameters/sortDirection' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/X-Api-Language' responses: '200': description: Applications 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/EntryList' application/xml: schema: $ref: '#/components/schemas/EntryList' '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: entryEntrantFilter: name: applicant in: query required: false description: Filter by applicant slug. schema: type: string entryModerationFilter: name: moderation in: query required: false description: Filter by moderation status. schema: type: string enum: - approved - undecided - rejected entryPaymentStatusFilter: name: payment_status in: query required: false description: Filter by payment status. schema: type: string enum: - paid - awaiting_payment entryPriceFilter: name: price in: query required: false description: Filter by price slug. schema: type: string entryStatusFilter: name: status in: query required: false description: Filter by application status. schema: type: string enum: - submitted - in_progress - resubmission_required - resubmitted entryTitleFilter: name: title in: query required: false description: Filter by full or partial application name. schema: type: string entryUpdatedAtFilter: name: updated_at in: query required: false description: |- Filter by update timestamp. Supported values: * `[before]=YYYY-MM-DDTHH:MM:SSZ` * `[after]=YYYY-MM-DDTHH:MM:SSZ` * `[on]=YYYY-MM-DDTHH:MM:SSZ` * `[between]=[YYYY-MM-DDTHH:MM:SSZ,YYYY-MM-DDTHH:MM:SSZ]` schema: type: string categoryFilter: name: category in: query required: false description: Filter by category slug. schema: type: string chapterFilter: name: chapter in: query required: false description: Filter by chapter 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 archivedFilter: name: archived in: query required: false description: |- Filter by archive mode. * `only` - Show only archived resources. * `all` - Include archived resources. * `none` - Exclude archived resources. schema: type: string enum: - only - all - none 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: true 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 entryOrder: name: order in: query required: false description: Sort by a supported application field. schema: type: string enum: - category - chapter - applicant - local_id - parent_category - title - updated 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: EntryList: description: Paginated list of applications. allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: data: type: array description: Applications on the current page. items: $ref: '#/components/schemas/EntrySummary' example: current_page: 1 data: - applicant: slug: AbCdEfGh link: https://api.au.cr4ce.com/user/AbCdEfGh name: Ada Lovelace first_name: Ada last_name: Lovelace email: ada.lovelace@example.com global_id: 9c78dcbc-53cf-42f1-b5b3-82fe396f66e6 auto_score: 0 category: slug: EfGhIjKl link: https://api.au.cr4ce.com/category/EfGhIjKl name: en_GB: Short film chapter: slug: MnOpQrSt link: https://api.au.cr4ce.com/chapter/MnOpQrSt name: en_GB: Europe comments: 'Jordan Lee (2025-06-03T10:45:29+00:00): manager comment' contributor_count: 1 created: '2025-03-11T15:00:03Z' custom_deadline: '-' division: 2 eligibility_status: '' files_count: 1 form: slug: StUvWxYz link: https://api.au.cr4ce.com/form/StUvWxYz name: en_GB: Entry form grant_end_date: null grant_status: null local_id: 916 moderation_status: undecided parent_category: null payment_status: Paid plagiarism_scan_status: unscanned review_status: '' season: slug: BcDeFgHi link: https://api.au.cr4ce.com/season/BcDeFgHi name: en_GB: '2026' slug: PqRsTuVw status: submitted submitted: '2025-08-11T13:19:42Z' tags: documentary, finalist title: Documentary series updated: '2026-06-18T07:25:20Z' user_comments: 'Jordan Lee (2025-02-19T14:22:43+00:00): strong submission' - applicant: slug: IjKlMnOp link: https://api.au.cr4ce.com/user/IjKlMnOp name: Alan Turing first_name: Alan last_name: Turing email: alan.turing@example.com global_id: 2f4c9b1a-7d6e-4c3b-9a2f-1e8d5c7b6a40 auto_score: 0 category: slug: EfGhIjKl link: https://api.au.cr4ce.com/category/EfGhIjKl name: en_GB: Short film chapter: slug: MnOpQrSt link: https://api.au.cr4ce.com/chapter/MnOpQrSt name: en_GB: Europe comments: '' contributor_count: 0 created: '2025-04-02T09:12:00Z' custom_deadline: '-' division: null eligibility_status: '' files_count: 0 form: slug: StUvWxYz link: https://api.au.cr4ce.com/form/StUvWxYz name: en_GB: Entry form grant_end_date: null grant_status: null local_id: 917 moderation_status: undecided parent_category: null payment_status: Unpaid plagiarism_scan_status: unscanned review_status: '' season: slug: BcDeFgHi link: https://api.au.cr4ce.com/season/BcDeFgHi name: en_GB: '2026' slug: YzAbCdEf status: in_progress submitted: null tags: '' title: Working title updated: '2025-04-02T09:12:00Z' user_comments: '' 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. EntrySummary: type: object description: >- Core application fields shared by the list and single-application responses. properties: applicant: type: object description: Applicant who created and owns the application. properties: slug: type: string description: URL-safe identifier of the applicant. link: type: string format: uri description: URL of the applicant resource. name: type: string description: Full name of the applicant. first_name: type: string description: First name of the applicant. last_name: type: string description: Last name of the applicant. email: type: string format: email description: Email address of the applicant. global_id: type: string description: Globally unique identifier of the applicant. auto_score: type: integer description: Automated score calculated for the application. category: type: object description: Category the application is assigned to. properties: slug: type: string description: URL-safe identifier of the category. link: type: string format: uri description: URL of the category resource. name: type: object description: >- Name of the category. 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 chapter: type: object description: Chapter the entry is assigned to. properties: slug: type: string description: URL-safe identifier of the chapter. link: type: string format: uri description: URL of the chapter resource. name: type: object description: >- 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. additionalProperties: type: string comments: type: string description: Manager comments recorded on the entry, joined into a single string. contributor_count: type: integer description: Number of contributors linked to the application. created: type: string format: date-time description: Date and time when the entry was created. custom_deadline: type: string description: Custom submission deadline for the entry, or `-` when none is set. division: type: - integer - 'null' description: >- Division number assigned to the entry, or `null` when none is assigned. eligibility_status: type: string description: Eligibility status of the application. files_count: type: integer description: Number of files uploaded to the application. form: type: object description: Entry form used to capture the application. properties: slug: type: string description: URL-safe identifier of the form. link: type: string format: uri description: URL of the form resource. name: type: object description: >- 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 grant_end_date: type: - string - 'null' description: >- Date when the grant ends, or `null` when not applicable. Only present when the grants feature is enabled on the account. grant_status: type: - object - 'null' description: >- Grant status assigned to the entry, or `null` when none is set. Only present when the grants feature is enabled on the account. properties: slug: type: string description: URL-safe identifier of the grant status. link: type: string format: uri description: URL of the grant status resource. name: type: object description: >- Name of the grant status. 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 local_id: type: integer description: Sequential identifier of the entry within the account. moderation_status: type: string description: Moderation status of the application. parent_category: type: - object - 'null' description: >- Parent of the assigned category, or `null` when the category has no parent. properties: slug: type: string description: URL-safe identifier of the parent category. link: type: string format: uri description: URL of the parent category resource. name: type: object description: >- Name of the parent category. 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 payment_status: type: string description: Payment status of the application. plagiarism_scan_status: type: string description: Plagiarism scan status of the application. review_status: type: string description: Review status of the application. season: type: object description: Season the entry belongs to. properties: slug: type: string description: URL-safe identifier of the season. link: type: string format: uri description: URL of the season resource. name: type: object description: >- 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: URL-safe identifier of the application. status: type: string description: >- Submission status of the application. Possible values include `submitted`, `in_progress`, `resubmission_required`, `resubmitted`, `invited`, and `not_approved_for_submission`. submitted: type: - string - 'null' format: date-time description: >- Date and time when the entry was submitted, or `null` when not yet submitted. tags: type: string description: Tags applied to the entry, as a comma-separated list. title: type: string description: Title of the application. updated: type: string format: date-time description: Date and time when the entry was last updated. user_comments: type: string description: Comments left by users on the entry, joined into a single string. 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. ````