---
title: "List clients"
method: GET
path: "/partner_api/v1/clients"
tags: ["Clients"]
---

# List clients

`GET /partner_api/v1/clients`

## Request

- Base URL: `https://api.contentsnare.com`
- URL: `https://api.contentsnare.com/partner_api/v1/clients`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/oauth/authorization`
    - Token URL: `/oauth/token` scopes: `read_clients`
  - HTTP bearer

Returns list of active clients<br>Required scopes: <b>read_clients</b>

## Query parameters

- `limit` integer
- `offset` integer
- `include_external` boolean
- `q` string
- `q_by[]` string[]
- `filter_by[email]` string
- `filter_by[full_name]` string
- `filter_by[phone]` string
- `sort_by` 'client_companies.name' | 'email' | 'full_name' | 'phone'
- `sort_direction` 'asc' | 'desc'

## Response `200`

successful

- object
  - `pagination` PaginationClients
    - `limit` integer
    - `offset` integer
    - `q` string
    - `q_by` string[]
    - `sort_by` string
    - `sort_direction` string
    - `filter_by` object
    - `total_count` integer
  - `results` Client[]
    - `avatar` string
    - `client_companies` ClientCompany[]
      - `id` string
      - `name` string
    - `company_name` string
    - `email` string
    - `full_name` string
    - `first_name` string
    - `last_name` string
    - `id` string
    - `phone` string
    - `salutation` string
    - `language_code` string

## Other responses

- `401`: unauthorized
- `403`: forbidden

---

[API](https://skmtc.dev/contentsnare/apis/api-general-info.md) - [All operations](https://skmtc.dev/contentsnare/apis/api-general-info/llms.txt) - [OpenAPI document](https://skmtc.dev/contentsnare/apis/api-general-info/revisions/d3048549a0ba?raw)