List session statuses

GET/v1/event/{eventId}/statuses

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

Returns the event's session status definitions, newest first.

Paginated: up to pageSize per page (default 25, maximum 100), with a pagination object alongside the results. This page previously described an unpaginated array, which is why a caller with more than 25 session status definitions appeared to be missing some.

Request example

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/event/{eventId}/statuses' \
  --header 'x-access-token: <api-token>'

const response = await fetch('https://public-api.sessionboard.com/v1/event/{eventId}/statuses', {
  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/event/{eventId}/statuses",
    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/event/{eventId}/statuses",
    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/event/{eventId}/statuses", 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/event/{eventId}/statuses"))
    .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

eventIdintegerpathrequired
The event ID.

Query parameters

pageintegerquery
Page number for pagination.
Default
1
Minimum
1
Maximum
999
pageSizeintegerquery
Number of results per page.

The event-settings list endpoints (tags, tracks, levels, formats, rooms, languages, statuses) also accept the older spelling page_size, and used to accept only that — a request sending pageSize silently got the default 25. Both now work, pageSize wins when both are sent, and on these endpoints a value outside 1–100 is clamped rather than rejected. Everywhere else pageSize is the only spelling.
Default
25
Minimum
1
Maximum
100

Responses

200`application/json`

dataSessionCustomStatus[]
Show child attributes
- idstring
- namestring
- statusstring
  Approval state this custom label maps onto. Stored NOT NULL, so it is always present on a status created through this API.
  Allowed values
  "pending", "accepted", "declined", "accept_queue", "decline_queue"
- status_namestring | null
- colorstring
- orderinteger
- is_customboolean
- created_atstring | null
- created_by_user_idinteger | null
- created_by_user_namestring | null
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

Unauthorized

404

Event not found

Response examples

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "pending",
      "status_name": "<string>",
      "color": "<string>",
      "order": 123,
      "is_custom": true,
      "created_at": "<string>",
      "created_by_user_id": 123,
      "created_by_user_name": "<string>"
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 25,
    "total_pages": 4,
    "total_results": 97
  }
}