---
title: "List External User Mapping"
method: GET
path: "/v2/company/{company_id}/external_user_mappings"
tags: ["External User Mappings"]
---

# List External User Mapping

`GET /v2/company/{company_id}/external_user_mappings`

## Path parameters

- `company_id` integer, required

## Query parameters

- `location_id` integer
- `user_id` integer
- `external_user_id` string
- `modified_since` string — A date with YYYY-MM-DD format
- `cursor` string
- `limit` integer

## Headers

- `x-api-version` string — An API version
- `x-company-guid` string, uuid

## Response `200`

Success

- object
  - `object` 'external_user_mappings', required
  - `data` object[], required
    - `id` integer, required — Mapping ID
    - `user_id` integer, nullable, required — User ID in 7Shifts
    - `external_user_id` string, nullable, required — User ID in External System
    - `company_id` integer, nullable, required — Company ID
    - `location_id` integer, nullable, required — Location ID
    - `application_name` string, required — Name key of the application this mapping is connected with
    - `created` string, date-time, nullable, required — The ISO8601 date and time in UTC when the mapping was created
    - `modified` string, date-time, nullable, required — The ISO8601 date and time in UTC when the mapping was modified
    - `user_active` boolean, required — Boolean indicating whether the mapped 7Shift user is currently active
  - `meta` object, required
    - `cursor` object
      - `current` string, nullable, required — The current cursor.
      - `prev` string, nullable, required — A cursor for navigating to the previous page.
      - `next` string, nullable, required — A cursor for navigating to the next page.
      - `count` integer, nullable, required — The total items in the current cursor.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Unexpected error

---

[API](https://skmtc.net/7shifts/apis/7shifts-api.md) · [All operations](https://skmtc.net/7shifts/apis/7shifts-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/7shifts/7shifts-api/revisions/96a02ef888ab/schema)