Skip to main content
GET
/
api
/
programs
List all programs for the organization
curl --request GET \
  --url http://localhost:3000/api/programs \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "mode": "batch",
    "organizationId": "<string>",
    "audienceId": "<string>",
    "flowId": "<string>",
    "status": "draft",
    "startAt": "<string>",
    "didPool": [
      {
        "id": "<string>",
        "number": "+212500000001",
        "country": "MA"
      }
    ],
    "retryStrategy": {},
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "stopAt": "<string>",
    "pauseWindows": {},
    "autoPauseRules": {}
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

List of programs

id
string
required

Program ID

name
string
required

Program name

mode
enum<string>
required

Program mode

Available options:
batch,
live
organizationId
string
required

Organization ID

audienceId
string
required

Audience ID. Set at creation for batch, auto-created for live.

flowId
string
required

Flow ID

status
enum<string>
required

Program lifecycle status. Operational status is on executions.

Available options:
draft,
active,
archived
startAt
string
required

Scheduled start time

didPool
object[]
required

Resolved DID pool

retryStrategy
object
required

Retry strategy

createdAt
string
required

Created at

updatedAt
string
required

Updated at

triggerCondition
object

Trigger condition (live mode only)

stopAt
string | null

Scheduled stop time

pauseWindows
object

Pause windows

autoPauseRules
object

Auto-pause rules