Skip to main content
GET
List Enrollments

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Query Parameters

entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

Required array length: 1 element
Example:
limit
integer
default:50

Number of items to return (defaults to 50, maximum 50)

Required range: x <= 50
offset
integer

Index to start from (defaults to 0)

Response

Enrollment data

paging
Paging · object
required
enrollments
object[]
required

The array of enrollments.