List Clients

get

https://api.scalepad.com/core/v1/clients

This endpoint retrieves a detailed list of clients. The endpoint supports filtering and sorting based on various criteria.

A client is an active customer organization managed by the MSP, enriched with data such as employee and device counts, geographic details, and other customer-specific details.

Query Params

filter[id]

string

Filters records by using a query string on the field id.

Supports comparison operators: eq, in.

Query examples:

filter[id]=example_value - to filter for exact match.
filter[id]=eq:example_value - to filter for exact match.
filter[id]=in:example_value_1,example_value_2,example_value_3 - to filter when any item in the list matches.

filter[name]

string

Filters records by using a query string on the field name.

Supports comparison operators: eq, in, cont.

Query examples:

filter[name]=example_value - to filter for exact match.
filter[name]=eq:example_value - to filter for exact match.
filter[name]=in:example_value_1,example_value_2,example_value_3 - to filter when any item in the list matches.
filter[name]=cont:word - to filter using a partial match.

filter[lifecycle]

string

Filters records by using a query string on the field lifecycle.

Supports comparison operators: eq, in.

Query examples:

filter[lifecycle]=example_value - to filter for exact match.
filter[lifecycle]=eq:example_value - to filter for exact match.
filter[lifecycle]=in:example_value_1,example_value_2,example_value_3 - to filter when any item in the list matches.

filter[num_contacts]

string

Filters records by using a query string on the field num_contacts.

Supports comparison operators: eq, gt, gte, lt, lte.

Query examples:

filter[num_contacts]=42 - to filter for exact match.
filter[num_contacts]=eq:42 - to filter for exact match.
filter[num_contacts]=gt:42 - to filter for greater than
filter[num_contacts]=gte:42 - to filter for greater than or equal to
filter[num_contacts]=lt:42 - to filter for less than
filter[num_contacts]=lte:42 - to filter for less than or equal to

filter[num_hardware_assets]

string

Filters records by using a query string on the field num_hardware_assets.

Supports comparison operators: eq, gt, gte, lt, lte.

Query examples:

filter[num_hardware_assets]=42 - to filter for exact match.
filter[num_hardware_assets]=eq:42 - to filter for exact match.
filter[num_hardware_assets]=gt:42 - to filter for greater than
filter[num_hardware_assets]=gte:42 - to filter for greater than or equal to
filter[num_hardware_assets]=lt:42 - to filter for less than
filter[num_hardware_assets]=lte:42 - to filter for less than or equal to

filter[record_created_at]

string

Filters records by using a query string on the field record_created_at.

Supports comparison operators: gt, gte, lt, lte.

Query examples:

filter[record_created_at]=gt:2023-01-01T00:00:00Z - to filter for dates after
filter[record_created_at]=gte:2023-01-01T00:00:00Z - to filter for dates after or on
filter[record_created_at]=lt:2023-01-01T00:00:00Z - to filter for dates before
filter[record_created_at]=lte:2023-01-01T00:00:00Z - to filter for dates before or on

filter[record_updated_at]

string

Filters records by using a query string on the field record_updated_at.

Supports comparison operators: gt, gte, lt, lte.

Query examples:

filter[record_updated_at]=gt:2023-01-01T00:00:00Z - to filter for dates after
filter[record_updated_at]=gte:2023-01-01T00:00:00Z - to filter for dates after or on
filter[record_updated_at]=lt:2023-01-01T00:00:00Z - to filter for dates before
filter[record_updated_at]=lte:2023-01-01T00:00:00Z - to filter for dates before or on

sort

array of strings

One or more sortable fields, separated by commas. Prefix with '+' to sort ascending or '-' to sort descending.

sort

page_size

int32

1 to 200

The number of records to be returned in a single page

cursor

string

The pointer used to fetch a certain page of records

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

500Internal Server Error