---
title: "Get all partners"
method: GET
path: "/partners"
tags: ["Partners"]
---

# Get all partners

`GET /partners`

Get a list of partners accepted in the CareCloud platform.

## Query parameters

- `count` integer
- `offset` integer
- `sort_field` string
- `sort_direction` 'ASC' | 'DESC'

## Headers

- `Accept-Language` string

## Response `200`

OK

- object
  - `data` object
    - `partners` Partner[] — List of a partners.
      - `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` Address — 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.
        - `address1` string — Street name of the address.
        - `address2` string — Street number (Land registry number).
        - `address3` string — House number.
        - `address4` string — Next address data.
        - `address5` string — Next address data.
        - `address6` string — Next address data.
        - `address7` string — Next address data.
        - `zip` string — ZIP code.
        - `city` string — City.
        - `country_code` string — ISO code of the country. *Possible values de / gb / us / it / cz / etc*
      - `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.
      - `email` string — Email of the company.
      - `phone` string — Phone number of the company with international prefix (420000000).
      - `state` 0 | 1 | 2 — State of the partner. *Possible values are: 0 - deleted / 1 - active*
    - `total_items` integer — The number of all found partners.

## Other responses

- `400` — Bad input parameter. The response body's `error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.
- `401` — The client has invalid credentials or auth token.
- `403` — The client does not exist or the client tried to access an unauthorized property or resource.
- `404` — The resource was not found.
- `405` — The resource does not support the specified HTTP method.
- `429` — Too many requests - more than the resource limit.
- `500` — Server is not working as expected.
- `503` — Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

---

[API](https://skmtc.net/crmcarecloud/apis/rest-api-reference.md) · [All operations](https://skmtc.net/crmcarecloud/apis/rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crmcarecloud/rest-api-reference/revisions/329c06dbf8d9/schema)