Skip to main content
GET
Get all pathway enrolments

Authorizations

Authorization
string
header
required

Your organisation's API key, sent as Authorization: my_api_key. The key can also be passed as an api_key query parameter. See Authentication.

Query Parameters

pathway_ids
string

Comma separated list of pathway ids, eg 1,17

pathway_id
integer

A single pathway id

user_name
string

Only enrolments for this user (case-insensitive)

user_id
integer

Only enrolments for this internal user ID (person.id)

page
integer
default:1

Results page to return

max_per_page
integer
default:25

Maximum number of results per page. Maximum permitted page size is 100. Larger values are reduced to 100.

updated_at
string

Only records updated after this time, in UTC. Use the ISO 8601 form "yyyy-mm-ddThh:mm:ss", eg "2023-02-01T15:12:13". Do not include a time zone offset

Example:

"2023-02-01T15:12:13"

Response

A page of pathway enrolments

total_records
integer

Total number of records

max_per_page
integer

Maximum number of results per page

current_page
integer

Results page returned

total_pages
integer

Total number of pages

records
object[]