List all ID mappings

Required OAuth scope: externalIds:read.

This endpoint is paginated with a page size of 5,000 external IDs. For more information, see the Pagination guide.

Lists all external ID mappings that link resources together.

Query Params
platform
object

Filter on platform property with LHS bracket notation.

Expected value format is a string.

type
object

Filter on type property with LHS bracket notation.

Expected value format is a string (attempt, classroom, classroomAttendance, classroomAttendanceSheet, classroomSlot, classroomSlotRegistration, course, group, learningNeed, path, pathEnrollment, pathSession, pathTracking, registrationRequest, user).

value
object

Filter on value property with LHS bracket notation.

Expected value format is a string.

targetId
object

Filter on targetId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

Headers
string
enum
required

The version of the API.

Allowed:
Responses

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