Skip to main content
GET
Get Lms Enrollments

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

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

remote_id
string | null

The third-party API ID of the matching object.

include_raw_data
boolean
default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

ids
string | null

If provided, will only return enrollments for these IDs.

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"

user
string | null

If provided, will only return enrollments for these users.

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"

course
string | null

If provided, will only return enrollments for these courses.

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6,018b18ef-c487-703c-afd9-0ca478ccd9d7"

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

page_size
integer
default:50

Number of results to return per page. Maximum size is 200.

Required range: 1 <= x <= 200
cursor
string | null

The pagination cursor value.

expand
string | null

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.

Example:

"manager[first_name,last_name]"

start_date_from
string | null

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.

Example:

"2024-02-21T21:22:12.993Z"

start_date_to
string | null

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.

Example:

"2024-02-21T21:22:12.993Z"

end_date_from
string | null

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.

Example:

"2024-02-21T21:22:12.993Z"

end_date_to
string | null

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.

Example:

"2024-02-21T21:22:12.993Z"

Response

Successful Response

cursor
string | null
required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size
integer
required

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.

Example:

50

items
LmsEnrollment · object[]
required

List of items in the current response