List awards programs

GET/v1/organization/{orgId}/awards/workspace/programs

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

Every awards program the token's user may see (the programs they manage, within their portfolios), newest first, each with its status, categories, its review pass dates, its public link once open, and counts (submitted, drafts, reviewers, complete scorecards, reviewed nominations, winners). Not paginated. Reads only. Requires read:awards; the token's user needs the Awards read permission. Refused for a key restricted to particular events. Also at GET /v1/awards/workspace/programs.

Request example

cURL

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

JavaScript

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

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

Python

import requests

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

print(response.json())

PHP

<?php

$curl = curl_init();

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

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

echo $response;

Go

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs", 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))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs"))
    .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

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

orgId*

GET

Send request

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.

Responses

200application/json

OK

• successboolean
• payloadobject
  Show child attributes

  • programsAwardsWorkspaceProgram[]
    Show child attributes

    • idstring<uuid>
    • namestring
    • nomenclaturestring

      Allowed values

      "awards", "grants", "scholarships"

    • descriptionstring | null
    • nomination_modestring

      nominate_others: people nominate someone else. self_only: people submit for themselves. Defaults to the audience's mode.

      Allowed values

      "nominate_others", "self_only"

    • statusstring

      Worked out from the dates: open while it is on the Awards Site and its nomination window is running, reviewing after nominations close, closed when it has nominations and every date has passed.

      Allowed values

      "draft", "open", "reviewing", "closed", "archived"

    • decidedboolean

      At least one winner has been picked.

    • roundAwardsWorkspaceRound | any | null
      Show child attributes

      • idstring<uuid>
      • namestring
      • submission_start_datestring<date-time> | null
      • submission_end_datestring<date-time> | null

        The nomination deadline.

      • review_start_datestring<date-time> | null
      • review_end_datestring<date-time> | null
    • roundsinteger

      How many Rounds the program has (one on self-serve).

    • categoriesAwardsWorkspaceCategory[]
      Show child attributes

      • idstring<uuid>
      • namestring
    • categories_revisionstring

      Send this as baseRevision when replacing the categories.

    • public_urlstring | null

      The program's sign-in page on the Awards Site, once it has been opened. Empty when the Site has no address yet.

    • countsAwardsWorkspaceProgramCounts
      Show child attributes

      • submittedinteger

        Submitted nominations.

      • draftsinteger

        Nominations started and not submitted.

      • reviewersinteger
      • scorecardsinteger

        Finished scorecards.

      • reviewedinteger

        Submitted nominations with at least one finished scorecard.

      • winnersinteger
    • created_atstring<date-time>

401

Missing, invalid or expired token.

403application/json

• SCOPE_REQUIRED: the token lacks read:awards. A write scope does not grant reads; a legacy token with no scopes may read.
• ORG_WIDE_TOKEN_REQUIRED: the key is restricted to particular events. The Awards workspace covers every awards program in the organization, so use a key without an event restriction.
• FORBIDDEN: the token's user is not an active member of the organization, lacks the Awards read permission, or does not manage the program.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

404application/json

NOT_FOUND: orgId is not the token's organization.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

429application/json

• The token's request limit (100 requests per 15 minutes by default, per bucket). Wait Retry-After seconds. The body is the TooManyRequestsError shape — see Rate Limiting.
• Writes only: QUOTA_EXCEEDED, the token's daily write quota (10,000 writes a day). It resets at midnight UTC.

• responseTooManyRequestsError | AwardsWorkspaceError
  name: TooManyRequestsError (TooManyRequestsError)

  Body of a 429 from the API's own request limits (per token, and per organization and user). Wait Retry-After seconds.

  • statusinteger

    Example

    429

  • successboolean

    Example

    false

  • messagestringrequired

    Example

    "Error while trying to reach the endpoint: Too many requests"

  • namestringrequired

    Allowed values

    "TooManyRequestsError"

  Option 2 (AwardsWorkspaceError)

  Error body for the Awards workspace operations.

  • errorstringrequired

    Allowed values

    "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

  • messagestringrequired
  • codestring

    A more specific reason, when there is one (trial_ended, plan_ended).

• Retry-Afterintegerheader

  Seconds to wait before retrying.

Response examples

200

{
  "success": true,
  "payload": {
    "programs": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "nomenclature": "awards",
        "description": "<string>",
        "nomination_mode": "nominate_others",
        "status": "draft",
        "decided": true,
        "round": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "submission_start_date": "2026-01-15T09:30:00Z",
          "submission_end_date": "2026-01-15T09:30:00Z",
          "review_start_date": "2026-01-15T09:30:00Z",
          "review_end_date": "2026-01-15T09:30:00Z"
        },
        "rounds": 123,
        "categories": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        ],
        "categories_revision": "<string>",
        "public_url": "<string>",
        "counts": {
          "submitted": 123,
          "drafts": 123,
          "reviewers": 123,
          "scorecards": 123,
          "reviewed": 123,
          "winners": 123
        },
        "created_at": "2026-01-15T09:30:00Z"
      }
    ]
  }
}

403 · Token lacks the read scope

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

403 · Key restricted to particular events

{
  "error": "ORG_WIDE_TOKEN_REQUIRED",
  "message": "The Awards workspace covers every awards program in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
}

404

{
  "error": "NOT_FOUND",
  "message": "Organization not found"
}

429

{
  "status": 429,
  "success": false,
  "message": "Error while trying to reach the endpoint: Too many requests",
  "name": "TooManyRequestsError"
}