Skip to main content
GET
Browse programs

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

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
page
integer
default:1

Pagination page number

Required range: x >= 1
limit
integer
default:25

Items to return per page

Required range: 1 <= x <= 100
status
enum<string>

Narrow programs by status

Available options:
draft,
active,
paused,
completed,
archived

Find programs by name

Response

Programs returned successfully

data
object[]
page
integer
total
integer
totalPages
integer