Partners

A Partner is an entity that owns and manages a defined group of customer data in the CareCloud platform based on consent to the processing of personal data. The users of a specific Partner have no access to the customer data of another Partner. Each user is linked to a particular Partner. You can get here the list of Partners available.

Available methods

All available methods for the resource Partners.

HTTP method Endpoint Description
[badge-blue GET] /partners Get information about all partners
[badge-blue GET] /partners/{partner_id} Get information about a specific partner

Get all partners

Get a list of partners accepted in CRM CareCloud
[badge-blue GET ] /partners

Query parameters

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
partners Partners[] List of a partners
total_items integer Count of all found partners

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/partners
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2wmYw==

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 14:40:06 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "partners": [
      {
        "partner_id": "86e05affc7a7abefcd513ab400",
        "name": "Demo",
        "address": {
          "address1": "U Elektry",
          "address2": "1",
          "address3": "2",
          "address4": null,
          "address5": null,
          "address6": null,
          "address7": null,
          "zip": "19000",
          "city": "Praha",
          "country_code": null
        },
        "registration_id": "123456789",
        "vat_id": "123456789",
        "email": "happy_user@crmcarecloud.com",
        "phone": "123456787",
        "state": 1
      },
      {
        "partner_id": "82d90993540a005ce1b9c61b8c",
        "name": "Fun Restaurant",
        "address": {
          "address1": "",
          "address2": "",
          "address3": "",
          "address4": null,
          "address5": null,
          "address6": null,
          "address7": null,
          "zip": "",
          "city": "",
          "country_code": null
        },
        "registration_id": "",
        "vat_id": "",
        "email": "",
        "phone": "",
        "state": 1
      },
      {
        "partner_id": "85d6598db0bf3f62afd5db8507",
        "name": "Nice bar",
        "address": {
          "address1": "",
          "address2": "",
          "address3": "",
          "address4": null,
          "address5": null,
          "address6": null,
          "address7": null,
          "zip": "",
          "city": "",
          "country_code": null
        },
        "registration_id": "",
        "vat_id": "",
        "email": "",
        "phone": "",
        "state": 1
      },
      {
        "partner_id": "8bda8a4854394325e2748a5005",
        "name": "test",
        "address": {
          "address1": "test",
          "address2": "1",
          "address3": "1",
          "address4": null,
          "address5": null,
          "address6": null,
          "address7": null,
          "zip": "25229",
          "city": "test",
          "country_code": null
        },
        "registration_id": "65262655",
        "vat_id": "65262655",
        "email": "happy_user@crmcarecloud.com",
        "phone": "+42760257",
        "state": 1
      }
    ],
    "total_items": 4
  }
}


Get a partner

Get information about a specific partner
[badge-blue GET ]/partners/{partner_id}

Path parameters

Parameter name Type Description
partner_id string The unique id for the partner

Response

Status code: 200 OK
Output structure : Partner

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/partners/86e05affc7a7abefcd513ab400
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZVcmZhY2U6YmVlZDA2ZjBmYhTEyUwOWIzNzk2ZjMODEEyZTIxNmVkMM5NDE5Zj2NzMwZmRj2wmYw==

Example response

HTTP/1.1 200 OK
Date: Tue, 29 Sep 2020 14:42:10 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "partner_id": "86e05affc7a7abefcd513ab400",
    "name": "Demo",
    "address": {
      "address1": "U Elektry",
      "address2": "1",
      "address3": "2",
      "address4": null,
      "address5": null,
      "address6": null,
      "address7": null,
      "zip": "19000",
      "city": "Praha",
      "country_code": null
    },
    "registration_id": "123456789",
    "vat_id": "123456789",
    "email": "happy_user@crmcarecloud.com",
    "phone": "123456787",
    "state": 1
  }
}