COcontentsnare
Client companies

List client companies

Returns list of client companies<br>Required scopes: <b>read_clients</b>

get/partner_api/v1/client_companies

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

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[]=name

sort_by'name'

Specifies value for sorting

sort_direction'asc' | 'desc'

Specifies direction for sorting

Response

successful

Example response

{
  "pagination": {
    "limit": 200,
    "q": "str",
    "q_by": [
      "name"
    ],
    "sort_by": "name",
    "sort_direction": "asc",
    "total_count": 425
  },
  "results": [
    {
      "id": "cmp_z105QJxhy7YdlX",
      "name": "Trantow LLC"
    }
  ]
}

Changes

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