Skip to main content
GET
List program pay structures

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

id
string
required

ID of the program

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency

Response

Pay structures returned successfully

programId
string
trial
object | null

The trial a creator who starts on the trial payscale runs now. null when no payscale is the trial, or when the brand ends the trial by hand.

data
object[]