---
title: "List all ID mappings"
method: GET
path: "/api/v2/external-ids"
tags: ["External IDs"]
---

# List all ID mappings

`GET /api/v2/external-ids`

> 🔑
>
> 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](https://360learning.readme.io/docs/pagination).

Lists all external ID mappings that link resources together.

## Query parameters

- `platform` object
  - `eq` string — Filter on values equal to the given one
  - `ne` string — Filter on values not equal to the given one
  - `in` string[] — Filter on values including the given ones
  - `nin` string[] — Filter on values excluding the given ones
- `type` object
  - `eq` 'attempt' | 'classroom' | 'classroomAttendance' | 'classroomAttendanceSheet' | 'classroomSlot' | 'classroomSlotRegistration' | 'course' | 'group' | 'learningNeed' | 'path' | 'pathEnrollment' | 'pathSession' | 'pathTracking' | 'registrationRequest' | 'user' — Filter on values equal to the given one
  - `ne` 'attempt' | 'classroom' | 'classroomAttendance' | 'classroomAttendanceSheet' | 'classroomSlot' | 'classroomSlotRegistration' | 'course' | 'group' | 'learningNeed' | 'path' | 'pathEnrollment' | 'pathSession' | 'pathTracking' | 'registrationRequest' | 'user' — Filter on values not equal to the given one
  - `in` string[] — Filter on values including the given ones
  - `nin` string[] — Filter on values excluding the given ones
- `value` object
  - `eq` string — Filter on values equal to the given one
  - `ne` string — Filter on values not equal to the given one
  - `in` string[] — Filter on values including the given ones
  - `nin` string[] — Filter on values excluding the given ones
- `targetId` object
  - `eq` string, ObjectId — Filter on values equal to the given one
  - `ne` string, ObjectId — Filter on values not equal to the given one
  - `in` string[] — Filter on values including the given ones
  - `nin` string[] — Filter on values excluding the given ones

## Headers

- `360-api-version` 'v2.0', required

## Response `200`

Returns one page of 5000 external IDs.

- ExternalIdDTO[]
  - `platform` string, required — The name of the platform where the external ID comes from.
  - `targetId` string, ObjectId, required — The resource ID to which the external ID is linked.
  - `targetType` 'attempt' | 'classroom' | 'classroomAttendance' | 'classroomAttendanceSheet' | 'classroomSlot' | 'classroomSlotRegistration' | 'course' | 'group' | 'learningNeed' | 'path' | 'pathEnrollment' | 'pathSession' | 'pathTracking' | 'registrationRequest' | 'user', required — The resource type to which the external ID is linked.
  - `value` string, required — The value of the external ID.
  - `_id` string, ObjectId, required — The unique ID that identifies the resources mapping.

## Other responses

- `401` — The given access token is either missing, invalid, has expired, or has been revoked.
- `403` — The given access token does not have the required OAuth scope to execute the request.
- `429` — The client has sent too many requests in a short amount of time.

---

[API](https://skmtc.net/360learning/apis/core-api.md) · [All operations](https://skmtc.net/360learning/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/360learning/core-api/revisions/94b691b0b72c/schema)