> ## 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. # Get tab > Get the tab identified by the specified slug. ## OpenAPI ````yaml /api-reference/openapi-v2_3.yaml get /tab/{tab_slug} 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 organisation account. The account resource provides metadata about the tenant associated with your API key. Note: Account information is read-only and contains organisation-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 categorisation. Attachments remain associated with their entry throughout the entry lifecycle. - name: Categories description: >- Use these operations to manage competition categories or award divisions. Categories organise 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 organisational divisions within your programs. Chapters enable you to run regional competitions, manage local awards, or organise 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 organised 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 organised 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. - 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: Tabs description: >- Use these operations to manage the tabs that divide a form into sections. Each tab groups what the form collects at that point, such as the entry details, custom fields, attachments, contributors, or referees. Every form holds a locked details tab. Add tabs of the other types yourself, then place fields on them with the Fields operations. Show a tab in every category or only in selected categories, and hide a tab from entrants while it stays visible to program managers. - 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 organisation. 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: /tab/{tab_slug}: parameters: - $ref: '#/components/parameters/tabSlug' get: tags: - Tabs summary: Get tab description: Get the tab identified by the specified slug. operationId: GetTabV23 parameters: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/X-Api-Language' responses: '200': description: Tab 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/Tab' application/xml: schema: $ref: '#/components/schemas/Tab' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '503': $ref: '#/components/responses/ServiceUnavailable' components: parameters: tabSlug: name: tab_slug in: path required: true description: Slug of the tab. schema: type: string pattern: ^[A-Za-z]{8}$ 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: Tab: title: Tab description: >- Section of a form that groups what is collected from entrants, such as entry details, custom fields, attachments, contributors, or referees. type: object properties: categories: type: array description: >- Categories the tab is shown in, or `["*"]` when it is shown in every category. `category_option` says which of the two a tab is using, so read that rather than testing for the marker. The same shape is used by the `categories` property of a field. items: oneOf: - type: object properties: slug: type: string description: Short URL-safe identifier for the category. link: type: string format: uri description: Canonical URL for the category resource. name: type: object description: >- Map of translated strings keyed by locale code (for example, `en_GB` or `fr_FR`). additionalProperties: type: string - type: string enum: - '*' category_option: type: string description: |- How categories are applied to the tab. * `all` - Shown in every category. * `select` - Shown only in the categories listed in `categories`. enum: - all - select content_block: type: - object - 'null' description: >- Content block shown at the top of the tab, or `null` when no content block is assigned. properties: slug: type: string description: Short URL-safe identifier for the content block. link: type: string format: uri description: Canonical URL for the content block resource. name: type: object description: >- Map of translated strings keyed by locale code (for example, `en_GB` or `fr_FR`). additionalProperties: type: string created: type: string format: date-time description: Date and time when the tab was created. field_count: type: integer description: Number of fields attached to the tab. form: type: string pattern: ^[A-Za-z]{8}$ description: Slug of the form the tab belongs to. locked: type: boolean description: >- Specifies whether the tab is locked. A locked tab always holds position `1` and you cannot reorder or delete it. name: type: object description: >- Display name of the tab, as a map of translated strings keyed by locale code. additionalProperties: type: string order: type: integer description: >- Position of the tab within the form, where lower values appear first. resource: type: string description: |- Resource the tab collects data for. * `entries` - Part of an entry form. * `users` - Part of the user profile form. enum: - entries - users season: type: object description: Season the tab 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: >- Map of translated strings keyed by locale code (for example, `en_GB` or `fr_FR`). additionalProperties: type: string settings: type: - object - 'null' description: >- Configuration that applies only to this type of tab, or `null` for a type that carries none, such as a details or fields tab. Each type populates its own properties and omits the rest: an attachments tab carries the upload limits, an eligibility tab the assessment and communication settings, a referees tab the reference limits, and a contributors tab the contributor limits. These are the limits the entrant form applies. Apply them in your own interface so that entrants do not upload files the form would refuse. properties: allowed_file_types: type: - object - array maxItems: 0 description: >- File extensions accepted, keyed by file type group. The groups are `documents`, `images`, `graphics`, `audio`, `video` and `archives`, and each extension belongs to the group it is listed under. An empty array (`[]`) when the tab accepts every extension the account allows. additionalProperties: type: array items: type: string accept_attachment_links: type: boolean description: >- Specifies whether the tab accepts a link to a file in place of an upload. min_attachments: type: - integer - 'null' description: >- Smallest number of attachments required, or `null` when no minimum is set. max_attachments: type: - integer - 'null' description: >- Largest number of attachments accepted, or `null` when no maximum is set. min_filesize: type: - number - 'null' description: >- Smallest accepted file size in megabytes, or `null` when no minimum is set. max_filesize: type: - number - 'null' description: >- Largest accepted file size in megabytes, or `null` when no maximum is set. The account file size limit applies as well, and the smaller of the two wins. min_video_length: type: - integer - 'null' description: >- Shortest accepted video length in seconds, or `null` when no minimum is set. max_video_length: type: - integer - 'null' description: >- Longest accepted video length in seconds, or `null` when no maximum is set. image_dimension_constraints: type: object description: >- Pixel dimensions accepted for uploaded images. Each value is `null` when that constraint is not set. properties: min_width: type: - integer - 'null' description: Smallest accepted image width in pixels. max_width: type: - integer - 'null' description: Largest accepted image width in pixels. min_height: type: - integer - 'null' description: Smallest accepted image height in pixels. max_height: type: - integer - 'null' description: Largest accepted image height in pixels. assessment_mode: type: - string - 'null' description: >- How an eligibility tab decides the outcome, or `null` when no mode is set. * `auto` - Scored against `min_eligibility_score`. * `manual` - Decided by a program manager. * `both` - Scored first, then confirmed by a program manager. enum: - auto - manual - both - null min_eligibility_score: type: - number - 'null' description: >- Score an entry must reach to be eligible. Applies when `assessment_mode` is `auto` or `both`. hide_other_tabs_when_ineligible: type: boolean description: >- Specifies whether the remaining tabs are hidden from an entry found ineligible. eligible_content_block: type: - string - 'null' description: Slug of the content block shown to an eligible entry. ineligible_content_block: type: - string - 'null' description: Slug of the content block shown to an ineligible entry. pending_eligibility_content_block: type: - string - 'null' description: >- Slug of the content block shown while eligibility is still being decided. eligible_notification: type: - string - 'null' description: Slug of the notification sent when an entry is found eligible. ineligible_notification: type: - string - 'null' description: Slug of the notification sent when an entry is found ineligible. pending_eligibility_notification: type: - string - 'null' description: >- Slug of the notification sent while eligibility is still being decided. review_stage: type: - string - 'null' description: Slug of the review stage a referees tab collects references for. min_referees: type: - integer - 'null' description: >- Smallest number of referees required, or `null` when no minimum is set. max_referees: type: - integer - 'null' description: >- Largest number of referees accepted, or `null` when no maximum is set. min_contributors: type: - integer - 'null' description: >- Smallest number of contributors required, or `null` when no minimum is set. max_contributors: type: - integer - 'null' description: >- Largest number of contributors accepted, or `null` when no maximum is set. example: allowed_file_types: images: - jpg - png video: - mp4 accept_attachment_links: false min_attachments: 1 max_attachments: 10 min_filesize: null max_filesize: 25 min_video_length: null max_video_length: 120 image_dimension_constraints: min_width: 800 max_width: 4000 min_height: 600 max_height: 4000 slug: type: string description: Short URL-safe identifier for the tab. tab_divider_on_pdfs: type: boolean description: >- Specifies whether generated PDF documents include a divider page for the tab. type: type: string description: |- Type of the tab, which determines what the tab collects. * `details` - Core entry details, such as the entry title and the category the entry is submitted to. * `attachments` - Supplementary files uploaded against the entry. * `contributors` - People credited on the entry alongside the entrant. * `fields` - Answers to the custom fields on the form. * `eligibility` - Answers used to assess whether the entry is eligible. * `referees` - Referees asked to provide a reference for the entry. enum: - details - attachments - contributors - fields - eligibility - referees updated: type: string format: date-time description: Date and time when the tab was last updated. visible_to_entrants: type: boolean description: >- Specifies whether entrants see the tab. A tab hidden from entrants stays visible to program managers, so use it to collect information entrants do not manage themselves. example: categories: - slug: KlMnOpQr link: https://api.au.cr4ce.com/category/KlMnOpQr name: en_GB: Documentary category_option: select content_block: null created: '2024-12-12T09:41:21Z' field_count: 6 form: GhIjKlMn locked: false name: en_GB: About you order: 20 resource: entries season: slug: EfGhIjKl link: https://api.au.cr4ce.com/season/EfGhIjKl name: en_GB: '2026' settings: null slug: StUvWxYz tab_divider_on_pdfs: true type: fields updated: '2026-04-13T13:45:50Z' visible_to_entrants: true 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 NotFound: allOf: - $ref: '#/components/schemas/BaseProblem' - type: object properties: status_code: type: integer minimum: 404 maximum: 404 TooManyRequests: allOf: - $ref: '#/components/schemas/BaseProblem' - type: object properties: status_code: type: integer minimum: 429 maximum: 429 BaseProblem: description: Standard error envelope for all API error responses. 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, `api` feature not enabled for the account, or a read-only API key used for a request that is not a `GET`. 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' NotFound: description: >- Resource identified by the path slug does not exist. Returned when the slug is well-formed but no record matches it. 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/NotFound' application/xml: schema: $ref: '#/components/schemas/NotFound' 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.