COcontentsnare
Clients

List clients

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

get/partner_api/v1/clients

Request

  • Base URL
    https://api.contentsnare.com
  • Auth
    • OAuth 2
      Authorization code: /oauth/authorization
      Token URL: /oauth/token scopes: read_clients
    • or HTTP bearer

Query parameters

limitinteger
Example:20

Specifies the maximum number of returned items

offsetinteger

Specifies how many items to skip from the beginning

include_externalboolean

Specifies whether to return clients from external sources (integrations) (include_external=true)

qstring

String to search in the values specified in the parameter q_by[]

q_by[]string[]

Specifies list of values where string from the parameter q will be searched. If it isn't set then the default list is used.<br><b>Examples:</b> q_by[]=email&q_by[]=full_name

filter_by[email]string
Example:james@example.com

Exact email filter. Matches the full email value case-insensitively; use q/q_by[] for substring search.

filter_by[full_name]string
Example:James Smith

Exact full name filter. Matches the full client name value; use q/q_by[] for substring search.

filter_by[phone]string
Example:+15551010001

Exact phone filter. Matches the full phone value; use q/q_by[] for substring search.

sort_by'client_companies.name' | 'email' | 'full_name' | 'phone'

Specifies value for sorting

sort_direction'asc' | 'desc'

Specifies direction for sorting

Response

successful

Example response

{
  "pagination": {
    "limit": 200,
    "q": "str",
    "q_by": [
      "email",
      "full_name"
    ],
    "sort_by": "email",
    "sort_direction": "asc",
    "filter_by": {
      "email": "james@example.com"
    },
    "total_count": 425
  },
  "results": [
    {
      "avatar": "https://example.com/user_avatar.jpeg",
      "client_companies": [
        {
          "id": "cmp_z105QJxhy7YdlX",
          "name": "Trantow LLC"
        }
      ],
      "company_name": "Trantow LLC",
      "email": "clayschaden@mail.org",
      "full_name": "Clay Schaden",
      "first_name": "Clay",
      "last_name": "Schaden",
      "id": "acc_MORVw9Cyq97AyN",
      "phone": "+1 (415) 555-1212",
      "salutation": "Dr",
      "language_code": "en"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.