List promo codes

GET/v1/organization/{orgId}/awards/programs/{programId}/promo-codes

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

Requires the read:awards scope.

Request example

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}/promo-codes' \
  --header 'x-access-token: <api-token>'

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}/promo-codes', {
  method: 'GET',
  headers: {
    "x-access-token": "<api-token>"
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}/promo-codes",
    headers={
        "x-access-token": "<api-token>"
    },
)

print(response.json())

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}/promo-codes",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}/promo-codes", nil)
  req.Header.Add("x-access-token", "<api-token>")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}/promo-codes"))
    .header("x-access-token", "<api-token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

Response headers

Authorizations

x-access-tokenstringheader
Organization API token. Generate from Organization Settings → API Tokens.
AuthorizationBearer <token>headeror
OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

orgIdstringpathrequired
Your organization ID. Any other organization returns 404.
programIdstring<uuid>pathrequired
The Awards program ID.

Query parameters

pageintegerquery
Page number for pagination.
Default
1
Minimum
1
Maximum
999
pageSizeintegerquery
Results per page. page_size is also accepted.
Default
25
Minimum
1
Maximum
100

Responses

200`application/json`

dataAwardsPromoCode[]
Show child attributes
- idstring<uuid>
- program_idstring<uuid>
- codestring
- typestring
  Allowed values
  "percentage", "flat"
- amountnumber
- starts_atstring<date-time> | null
- ends_atstring<date-time> | null
- redemption_countinteger
  Submissions the code has been applied to. Returned by the single-code GET only.
- created_atstring<date-time>
- updated_atstring<date-time>
paginationListPagination
Pagination metadata returned by the event-settings GET lists (tags, tracks, levels, formats, rooms, languages, statuses). Same numbers as Pagination, snake_case keys — these endpoints are served by a different layer, and the casing is longstanding.
Show child attributes
- current_pageinteger
- page_sizeinteger
- total_pagesinteger
- total_resultsinteger

401

Missing or invalid token

403`application/json`

Token lacks read:awards

errorstring
Allowed values
"VALIDATION_ERROR", "SCOPE_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT"
messagestring

404`application/json`

Not found — also returned for any id belonging to another organization

errorstring
Allowed values
"VALIDATION_ERROR", "SCOPE_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT"
messagestring

Response examples

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "SAVE20",
      "type": "percentage",
      "amount": 20,
      "starts_at": "2026-01-15T09:30:00Z",
      "ends_at": "2026-01-15T09:30:00Z",
      "redemption_count": 123,
      "created_at": "2026-01-15T09:30:00Z",
      "updated_at": "2026-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 25,
    "total_pages": 4,
    "total_results": 97
  }
}

{
  "error": "SCOPE_REQUIRED",
  "message": "Token missing required scope: read:awards"
}

{
  "error": "NOT_FOUND",
  "message": "Not found"
}