---
title: "Get User"
method: GET
path: "/business/v2/employees/{userId}"
tags: ["Users"]
---

# Get User

`GET /business/v2/employees/{userId}`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/employees/{userId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `employee_read`
- TypeScript: <https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/docs/business/v2/employees/:userId/get.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a specific `User` by ID.

## Path parameters

- `userId` string, required: The `User` ID.

## Response `200`

The returned resource is a single `User`.

- User
  - `id` string: The `User` ID.
  - `name` string: The name of the `User` (sortable: yes).
  - `surname` string: The surname of the `User` (sortable: yes).
  - `middlename` string: The middlename of the `User` (sortable: no).
  - `dob` string: The Date of birth of the `User`.
  - `job_title` string: The job title of the `User` (sortable: yes).
  - `department` string: The department of the `User` (sortable: no).
  - `email` string: The email address of the `User` (sortable: no).
  - `mobile` string: The mobile number of the `User` including the country code (sortable: no).
  - `mobile_prefix` string: The mobile number country code (sortable: no).
  - `custom_reference_id` string: The reference of the employee in an external system (sortable: yes).
  - `status` 'ACTIVE' | 'INACTIVE' | 'BLOCKED' | 'SUSPENDED' | 'PENDING' | 'ARCHIVED'
  - `visible` boolean: It determines whether the `User` is visible in the web console (sortable: yes).
  - `mobile_access` boolean: It determines whether the `User` has mobile access (sortable: no).
  - `web_access` boolean: It determines whether the `User` has web access (sortable: no).
  - `groups` string[]: The list of `Groups` ID the `User` is member of (sortable: no).
  - `shipping_address` Address
    - `id` string: The `Address` ID.
    - `recipient` string: The recipient of the `Address`
    - `name` string: The actual name of the `Address`.
    - `line1` string: The `Address` street.
    - `line2` string: An optional other street.
    - `country` string: The country of the `Address`.
    - `county` string: The county of the `Address`.
    - `city` string: The city of the `Address`.
    - `post_code` string: The postal code of the `Address`.
    - `delivery_phone_number` string: Delivery phone number
    - `default_shipping` boolean: True if the `Address` is the default shipping address.
    - `type` string: The type of the `Address`.
    - `category` 'USER' | 'COMPANY'
    - `user_id` string: The `User` ID, only if category of the `Address` is `USER`.
    - `creation_time` string: The date and time when the `Address` was created.
    - `last_update` string: The date and time when the `Address` was last updated.
  - `reports_to` string: The ID of the `User` it reports to.
  - `roles` UserRole[]: The list of `UserRole` of the `User`.
    - `id` string: The ID of the `UserRole`.
    - `name` string: The name of the `UserRole`.
    - `description` string: The description of the `UserRole`.
    - `scope` string: The scope of the `UserRole`.
  - `contact_id` string: The ID of the `Contact` assigned to the `User`. This information can be updated from the [Add Contact](ref:contact-add) and [Update Contact](ref:contact-update) endpoints.
  - `creation_time` string: The date and time when the `User` was created (sortable: yes).
  - `last_update` string: The date and time when the `User` was last updated (sortable: yes).
  - `work_status` 'AVAILABLE' | 'OUT_OF_OFFICE'

## Other responses

- `404`: One or more resource requested does not exist.

## Changes

- **2026-02-11** `e4706ef36e2a`: 7 warning, 7 info
  - removed the optional property `shipping_address/address_category` from the response with the `200` status
  - removed the optional property `shipping_address/address_type` from the response with the `200` status
  - removed the optional property `shipping_address/addressee_name` from the response with the `200` status
  - removed the optional property `shipping_address/addressee_surname` from the response with the `200` status
  - …10 more

[Operation history](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/changes/business/v2/employees/:userId/get.md)

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)