---
title: "Clients.get"
method: GET
path: "/entities/Clients/{id}"
tags: ["Client"]
---

# Clients.get

`GET /entities/Clients/{id}`

Returns Client with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

Client data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Client
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `default_unit` string, uri, required — Default sales unit for the user. New records the user creates are assigned to this unit by default. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.
    - `master_right` string, uri, required — User role assigned to the user. Determines what features and entities the user can access. Relation to MasterRight. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'MasterRight' object for properties.
    - `default_unit_id` string, uuid, required — Id of the default sales unit.
    - `email` string, required — Email. Readonly information from UserProfile.
    - `first_name` string — First name. Readonly information from UserProfile.
    - `last_active` string, date-time — Timestamp of the user's most recent login or API request.
    - `last_name` string — Last name. Readonly information from UserProfile.
    - `master_right_id` string, uuid, required — Id of the assigned user role.
    - `middle_name` string — Middle name. Readonly information from UserProfile.
    - `phone` string — Phone number. Readonly information from UserProfile.
    - `picture_url` string — Picture name. Readonly information from UserProfile.
    - `position` string — Job title or position of the user.
    - `region` string — Region. Readonly information from UserProfile.
    - `timezone` string — Timezone offset (DEPRECATED)Readonly information from UserProfile.
    - `type` 0 | 1 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Customer, 1 - Support
    - `revision` integer — Revision when entity was lastly changed.
    - `default_idp` integer — default_idp retrieved from user, if enabled [HEAVY]
    - `user_profile_id` integer — ID of the associated user account [HEAVY]
    - `unit_membership` string[], required — Sales units the user belongs to (as member or manager).
    - `appointment_favorite` string[] — Appointments marked as favorite by the user.
    - `task_favorite` string[] — Tasks marked as favorite by the user.
    - `account_favorite` string[] — Accounts marked as favorite by the user.
    - `contact_favorite` string[] — Contacts marked as favorite by the user.
    - `profile_favorite` string[] — Screen profiles marked as favorite by the user.
    - `report_favorite` string[] — Reports marked as favorite by the user.
    - `lead_favorite` string[] — Leads marked as favorite by the user.
    - `opportunity_favorite` string[] — Opportunities marked as favorite by the user.
    - `timezone_name` string — IANA timezone name from UserProfile
    - `name` string — Display name of the user, formatted according to the user's name format preference.
    - `formatted_name` string, required — Display name of the user (alias of name).
    - `unit_manager_ids` string[], required — Ids of all sales units the user manages, expanded to include all descendant units in each managed subtree.
    - `unit_member_ids` string[], required — Ids of sales units the user belongs to as a member only (not as a manager).
    - `user_recalculation_state` 'InProgress' | 'NoRecalculation' | 'Pending' — State of the user's row-level access recalculation: NoRecalculation (up to date), Pending (queued), or InProgress.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)