Gets enrolments by status.


This operation retrieves program enrolments by status only for programs that enrol contacts either through our API or through our surveys and forms tool.

🚧

Important

This operation won't return results for programs that enrol contacts using program enrolment rules created in the program builder.

📘

Pagination in our API

To learn about pagination in our API, check out Paging through data.

Path Params
string
enum
required

The enrolment status to filter by.

Allowed:
Query Params
int32
1 to 1000
Defaults to 1000

The number of records to select between 1 and 1000 to retrieve.

int32
≥ 1

The numbers of records to skip in the result set.

Responses

401

Invalid or missing credentials.

403

The account does not have the Programs permission.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json