> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.sessionboard.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a promo code > Requires the `read:awards` scope. ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/organization/{orgId}/awards/programs/{programId}/promo-codes/{promoCodeId} openapi: 3.1.0 info: title: Sessionboard Public API version: '1.0' description: >- REST API for managing sessions, speakers, contacts, sponsors, exhibitors, and event data on the Sessionboard platform. contact: name: Sessionboard Support email: support@sessionboard.com termsOfService: https://www.sessionboard.com/legal/terms-of-service servers: - url: https://public-api.sessionboard.com description: US Region - url: https://public-api-eu.sessionboard.com description: EU Region security: - ApiKey: [] - BearerToken: [] tags: - name: Events description: Manage events on the platform. - name: Sessions description: Search and retrieve sessions within an event. - name: Session Writes description: >- Create, update, delete, and restore sessions. Requires the `write:sessions` scope. - name: Contact Writes description: >- Create, update, delete, and restore contacts. Requires the `write:contacts` scope. - name: Exhibitor Writes description: >- Create, update, delete, and restore exhibitors. Requires the `write:exhibitors` scope. - name: Sponsor Writes description: >- Create, update, delete, and restore sponsors. Requires the `write:sponsors` scope. - name: Field Writes description: >- Create, update, and delete custom fields. Requires the `write:fields` scope. - name: Speakers description: Search and retrieve speakers within an event. - name: Participants description: | Search and retrieve every contact holding a session role on an event — speakers, chairpersons, moderators and custom roles — with the roles each one holds, and list the event's participant roles. - name: Contacts description: Search and retrieve contacts at the organization or event level. - name: Sponsors description: Search and retrieve sponsors within an event. - name: Exhibitors description: Search and retrieve exhibitors within an event. - name: Event Settings description: >- Retrieve event configuration such as fields, tags, tracks, rooms, formats, levels, languages, and session statuses. - name: GDPR description: Manage GDPR data access and erasure requests. - name: Insights description: >- Query event data using SbQL, generate queries with AI, and manage dashboards. - name: Metadata Writes description: >- Create, update, and delete session metadata (rooms, tracks, tags, formats, levels, languages, statuses). Requires the `write:metadata` scope. - name: Agenda Planning description: >- Manage agenda drafts, draft sessions, scheduling rules, and evaluation personas. Requires the `write:events` scope. - name: Dashboards & Widgets description: >- Create, read, update, and delete dashboards and widgets at the event or organization level. Requires `write:events` scope for writes. - name: Reports & Queries description: >- Create, read, update, delete, and run saved SbQL queries/reports at the event or organization level. Requires `write:events` scope for writes. - name: Transcriptions description: >- Transcript text on sessions — fragments, summaries, insights, and translations. Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Session Recordings description: >- Session audio files for recording archives (live capture or imported audio). Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Media description: >- Upload video or audio files for automatic transcription. Requires `read:media` / `write:media` scopes. - name: Session Files description: > Documents attached to sessions (PDFs, PowerPoint, Word, images, and similar). Simple upload: `POST .../files/upload` (multipart, max 50 MB). Direct-to-storage: create → PUT → complete (max 500 MB). Requires `read:sessions` / `write:sessions` scopes. See the [Uploading session files](/guides/uploading-session-files) guide. - name: OAuth description: >- OAuth 2.1 endpoints for AI client authorization (Claude, ChatGPT). Mounted at `/oauth/` (not `/v1/`). - name: Log Export description: > Pull your organization's API request, security and audit logs into a SIEM such as Splunk, Microsoft Sentinel or Elastic. Requires a dedicated API token with the `read:audit_logs` scope, which can call nothing else. See the [Exporting logs to a SIEM](/guides/exporting-logs-to-a-siem) guide. - name: Awards description: >- Read and manage Awards programs and their categories, rounds, promo codes, submissions and reviews. Organization-level: paths start at `/v1/organization/{orgId}/awards`. Requires `read:awards` / `write:awards` scopes. paths: /v1/organization/{orgId}/awards/programs/{programId}/promo-codes/{promoCodeId}: get: tags: - Awards summary: Get a promo code description: Requires the `read:awards` scope. operationId: get-awards-promo-code parameters: - $ref: '#/components/parameters/AwardsOrgId' - $ref: '#/components/parameters/AwardsProgramId' - name: promoCodeId in: path required: true schema: type: string format: uuid description: The promo code ID. responses: '200': description: OK content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AwardsPromoCode' '401': description: Missing or invalid token '403': description: Token lacks `read:awards` content: application/json: schema: $ref: '#/components/schemas/AwardsError' example: error: SCOPE_REQUIRED message: 'Token missing required scope: read:awards' '404': description: >- Not found — also returned for any id belonging to another organization content: application/json: schema: $ref: '#/components/schemas/AwardsError' example: error: NOT_FOUND message: Not found components: parameters: AwardsOrgId: name: orgId in: path required: true schema: type: string description: Your organization ID. Any other organization returns `404`. AwardsProgramId: name: programId in: path required: true schema: type: string format: uuid description: The Awards program ID. schemas: AwardsPromoCode: type: object properties: id: type: string format: uuid program_id: type: string format: uuid code: type: string examples: - SAVE20 type: type: string enum: - percentage - flat amount: type: number examples: - 20 starts_at: type: - string - 'null' format: date-time ends_at: type: - string - 'null' format: date-time redemption_count: type: integer description: >- Submissions the code has been applied to. Returned by the single-code GET only. created_at: type: string format: date-time updated_at: type: string format: date-time AwardsError: type: object properties: error: type: string enum: - VALIDATION_ERROR - SCOPE_REQUIRED - FORBIDDEN - NOT_FOUND - CONFLICT message: type: string securitySchemes: ApiKey: type: apiKey in: header name: x-access-token description: >- Organization API token. Generate from Organization Settings → API Tokens. BearerToken: type: http scheme: bearer description: >- OAuth 2.1 access token. Obtained via the OAuth PKCE flow at `/oauth/token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.