Get all partners

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/partners

Get a list of partners accepted in CRM CareCloud.

Responses

Response body

object

data

object

partners

array of objects

List of a partners.

partners

object

partner_id

string

The unique ID of the partner. Partner represents business, company, or organization in the CareCloud domain. CareCloud allows single partner setup or multiple partner setup depending on the business setup.

name

string

required

Name of the company.

address

object

The Address Structure in the API defines the standardized format for representing addresses throughout the system. This resource ensures consistency and accuracy in capturing address details, facilitating seamless integration and data exchange.

registration_id

string

Company registration number. National Registration unique ID of the company.

vat_id

string

VAT registration number. Value Added Tax unique ID of the company.

string

Email of the company.

phone

string

Phone number of the company with international prefix (420000000).

state

integer

State of the partner.
Possible values are: 0 - deleted / 1- active

1 2

total_items

integer

The number of all found partners.

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/partners?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
28
}
1
{
2
  "data": {
3
    "partners": [
4
      {
5
        "partner_id": "86e05affc7a7abefcd513ab400",
6
        "name": "Demo",
7
        "address": {
8
          "address1": "Old Town Square",
9
          "address2": "34",
10
          "address3": "1a",
11
          "address4": "",
12
          "address5": "",
13
          "address6": "",
14
          "address7": "",
15
          "zip": "11000",
16
          "city": "Prague 1",
17
          "country_code": "cz"
18
        },
19
        "registration_id": "123456789",
20
        "vat_id": "CZ123456789",
21
        "email": "happy_user@crmcarecloud.com",
22
        "phone": "420000000",
23
        "state": 1
24
      }
25
    ],

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.