---
title: "Query user"
method: GET
path: "/v2/users"
tags: ["Users"]
---

# Query user

`GET /v2/users`

This endpoint queries user of given company based on given identifier like email or external ID.
In case includeInactive is true, inactive users are also included in the response.

## Query parameters

- `companyId` string, uuid
- `tmcId` string, uuid
- `email` string, email
- `externalId` string
- `employeeId` string
- `includeInactive` boolean

## Response `200`

OK

- UserSummaryList
  - `length` integer
  - `elements` UserSummary[] — List of references containing id and name.
    - `id` string, uuid, required
    - `email` string, email
    - `externalId` string — The partner-assigned user identifier.
    - `persona` 'UNKNOWN_PERSONA' | 'EMPLOYEE' | 'GUEST' | 'PERSONAL' | 'RELATIVE' | 'ADHOC' — Persona of the user
    - `isActive` boolean — Whether the user is active or not.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/spotnana/apis/user-management-api.md) · [All operations](https://skmtc.net/spotnana/apis/user-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spotnana/user-management-api/revisions/72a5366b0bb3/schema)