Clients.get

Returns Client with given id

Responses

🟢200OK

application/json

Client data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (Client)

optional

is_delete_protected

boolean

read-onlyrequired

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.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

default_unit

string <uri>

required

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

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

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

string

required

Email. Readonly information from UserProfile.

Example:

string

first_name

string

read-onlyoptional

First name. Readonly information from UserProfile.

Example:

string

last_active

string <date-time>

read-onlyoptional

Datetime information.

Example:

2019-01-01T00:00:00

last_name

string

read-onlyoptional

Last name. Readonly information from UserProfile.

Example:

string

master_right_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

middle_name

string

read-onlyoptional

Middle name. Readonly information from UserProfile.

Example:

string

phone

string

read-onlyoptional

Phone number. Readonly information from UserProfile.

Example:

string

picture_url

string

read-onlyoptional

Picture name. Readonly information from UserProfile.

Example:

string

position

string

optional

Simple text input field.

Example:

string

region

string

read-onlyoptional

Region. Readonly information from UserProfile.

Example:

string

timezone

string

read-onlyoptional

Timezone offset (DEPRECATED)Readonly information from UserProfile.

Example:

string

type

enum<integer>

optional

Integer enum value: 0 - Customer, 1 - Support

Allowed values:

Example:

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

default_idp

integer <int32>

optional

default_idp retrieved from user, if enabled [HEAVY]

Example:

user_profile_id

integer <int32>

optional

ID of the associated user account [HEAVY]

Example:

unit_membership

array[string <uri>]

required

Relations to SalesUnits.

appointment_favorite

array[string <uri>]

optional

Relations to Appointments.

task_favorite

array[string <uri>]

optional

Relations to Tasks.

account_favorite

array[string <uri>]

optional

Relations to Accounts.

contact_favorite

array[string <uri>]

optional

Relations to Contacts.

profile_favorite

array[string <uri>]

optional

Relations to Profiles.

report_favorite

array[string <uri>]

optional

Relations to Reports.

lead_favorite

array[string <uri>]

optional

Relations to Leads.

opportunity_favorite

array[string <uri>]

optional

Relations to Opportunitys.

timezone_name

string

optional

IANA timezone name from UserProfile

Example:

string

name

string

optional

Example:

string

formatted_name

string

required

Example:

string

unit_manager_ids

array[string <uuid>]

required

unit_member_ids

array[string <uuid>]

required

user_recalculation_state

enum<string>

optional

Allowed values:

InProgressNoRecalculationPending

Example:

InProgress

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "default_unit": "http://example.com",
        "master_right": "http://example.com",
        "default_unit_id": "01234567-abcd-dcba-ffff-000000000000",
        "email": "string",
        "first_name": "string",
        "last_active": "2019-01-01T00:00:00",
        "last_name": "string",
        "master_right_id": "01234567-abcd-dcba-ffff-000000000000",
        "middle_name": "string",
        "phone": "string",
        "picture_url": "string",
        "position": "string",
        "region": "string",
        "timezone": "string",
        "type": 0,
        "revision": 1,
        "default_idp": 1,
        "user_profile_id": 1,
        "unit_membership": [
            "http://example.com"
        ],
        "appointment_favorite": [
            "http://example.com"
        ],
        "task_favorite": [
            "http://example.com"
        ],
        "account_favorite": [
            "http://example.com"
        ],
        "contact_favorite": [
            "http://example.com"
        ],
        "profile_favorite": [
            "http://example.com"
        ],
        "report_favorite": [
            "http://example.com"
        ],
        "lead_favorite": [
            "http://example.com"
        ],
        "opportunity_favorite": [
            "http://example.com"
        ],
        "timezone_name": "string",
        "name": "string",
        "formatted_name": "string",
        "unit_manager_ids": [
            "01234567-abcd-dcba-ffff-000000000000"
        ],
        "unit_member_ids": [
            "01234567-abcd-dcba-ffff-000000000000"
        ],
        "user_recalculation_state": "InProgress"
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses