ClientStoryReads.get

Returns ClientStoryRead with given id

Responses

🟢200OK

application/json

ClientStoryRead data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (ClientStoryRead)

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

appointment

string <uri>

optional

Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties.

task

string <uri>

optional

Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties.

string <uri>

optional

Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties.

memo

string <uri>

optional

Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties.

owner

string <uri>

required

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

activity_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

message_id

string <uuid>

optional

Relation to single abstract entity instance.
E.g. Relation to Lead/Oppty

Example:

01234567-abcd-dcba-ffff-000000000000

no_follow

boolean

optional

Boolean value.

Example:

false

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

read_at

string <date-time>

required

Datetime information.

Example:

2019-01-01T00:00:00

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

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",
        "appointment": "http://example.com",
        "task": "http://example.com",
        "email": "http://example.com",
        "memo": "http://example.com",
        "owner": "http://example.com",
        "activity_id": "01234567-abcd-dcba-ffff-000000000000",
        "message_id": "01234567-abcd-dcba-ffff-000000000000",
        "no_follow": false,
        "owner_id": "01234567-abcd-dcba-ffff-000000000000",
        "read_at": "2019-01-01T00:00:00",
        "revision": 1
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses