---
title: "Retrieve embed user"
method: GET
path: "/scim/v2/embed/users/{userId}"
tags: ["Users"]
---

# Retrieve embed user

`GET /scim/v2/embed/users/{userId}`

Retrieve an embed user using their unique ID. Use the [Retrieve user](/api/users/retrieve-user) endpoint to retrieve standard users.

## Path parameters

- `userId` string, required

## Response `200`

Embed user details

- ScimEmbedUser — An embed user object (SCIM 2.0)
  - `id` string — Unique identifier for the user
  - `userName` string — The user's email address
  - `displayName` string — The user's display name
  - `active` boolean — Whether the user is active
  - `emails` object[] — The user's email addresses
    - `primary` boolean — Whether this is the user's primary email
    - `value` string — The email address
  - `groups` object[] — User groups that the user belongs to
    - `display` string — The group's display name
    - `value` string — The group's unique identifier
  - `meta` object
    - `resourceType` string — The type of resource. This will be `User`.
    - `created` string, date-time — The time the user was created
    - `lastModified` string, date-time — The time the user was last uodated
  - `schemas` string[] — SCIM information about the type of schemas used in the API. For example, `urn:ietf:params:scim:schemas:core:2.0:User`
  - `embedEmail` string, nullable — The embed user's email address
  - `embedEntity` string — The embed entity identifier
  - `embedExternalId` string — The external ID for the embed user

## Other responses

- `404` — Not Found - Resource does not exist
- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

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