Get information about all related customers

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/{customer_id}/related-customers

Get a list of customers' relations in CRM CareCloud.

Path Params

customer_id

string

required

The unique ID of the customer.

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

Direction of sorting the response list.

related_customer_id

string

The unique ID of the related customer.

customer_relation_type_id

string

The unique ID of the customer relation type in CareCloud.

all_customer_relations

boolean

Defaults to false

The API call returns all relations (currently valid and relations from the past) in case of true value. If the parameter is not set or has value false, only currently valid relations are returned.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

related_customers

array of objects

Collection of all related customers.

related_customers

object

customer_relation_id

string

The unique ID of the customer relation.

related_customer_id

string

required

The unique ID of the related customer.

short_name

string

Short name of the customer.

customer_relation_type_id

string

required

The unique ID of the customer relation type.

is_leading

boolean

required

Parameter says, if related customer is a leader in their relationship. Example: Parent is a leader, child is a follower

valid_from

string

Date and time when customer relation starts. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date and time when customer relation ends. (YYYY-MM-DD HH:MM:SS)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the related customer. Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

total_items

integer

The number of all found related customers.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/customers/customer_id/related-customers?count=100&offset=0&all_customer_relations=false' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
18
 
1
{
2
  "data": {
3
    "related_customers": [
4
      {
5
        "customer_relation_id": "81eaeea13b8984a169c490a325",
6
        "related_customer_id": "8aa68a112c62ad5f84a22a0652",
7
        "short_name": "Peter D.",
8
        "customer_relation_type_id": "8bed991c68a470e7aaeffbf048",
9
        "is_leading": false,
10
        "valid_from": "2022-01-09 22:00:00",
11
        "valid_to": "2022-01-09 22:30:00",
12
        "last_change": "2022-06-23 11:47:22",
13
        "state": 1
14
      }
15
    ],
16
    "total_items": 1
17
  }
18
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.