# Query user

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.

Endpoint: GET /v2/users
Version: v2
Security: Bearer

## Query parameters:

  - `companyId` (string)
    Identifier for company to search user for. Please specify one of the companyId or tmcId.
    Example: "4974a66b-7493-4f41-908c-58ba81093947"

  - `tmcId` (string)
    Identifier for TMC to search user for. Please specify one of the companyId or tmcId.
    Example: "b83e9704-2e8e-4256-90bf-2e59c1bcf9f2"

  - `email` (string)
    Email ID of the user.
    Example: "user@example.com"

  - `externalId` (string)
    The partner-assigned user identifier.
    Example: "123456"

  - `includeInactive` (boolean)
    If true, include inactive users in the response.
    Example: true

## Response 200 fields (application/json):

  - `length` (integer)

  - `elements` (array)
    List of references containing id and name.

  - `elements.id` (string, required)

  - `elements.email` (string)

  - `elements.externalId` (string)
    The partner-assigned user identifier.
    Example: "user-1"

  - `elements.persona` (string)
    Persona of the user
    Enum: "UNKNOWN_PERSONA", "EMPLOYEE", "GUEST", "PERSONAL", "RELATIVE", "ADHOC"

  - `elements.isActive` (boolean)
    Whether the user is active or not.

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.