Get Lms Enrollments
Returns a list of LMS Enrollment objects.
Authorizations
Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.
The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.
Query Parameters
The third-party API ID of the matching object.
Whether to include the original data Bindbee fetched from the third-party to produce these models.
false
If provided, will only return enrollments for these IDs.
"018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"
If provided, will only return enrollments for these users.
"018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"
If provided, will only return enrollments for these courses.
"018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"
Whether to include custom fields in the response.
false
Number of results to return per page. Maximum size is 200.
1 <= x <= 200The pagination cursor value.
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.
"manager[first_name,last_name]"
If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.
"2024-02-21T21:22:12.993Z"
If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.
"2024-02-21T21:22:12.993Z"
If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.
"2024-02-21T21:22:12.993Z"
If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.
"2024-02-21T21:22:12.993Z"
Response
Successful Response
Cursor value to fetch next set of items
"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"
The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.
50
List of items in the current response