customers

Get a list of all customers

Requires the CUSTOMER.VIEW permission.

get/v{version}/customers

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/customers
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

limitinteger

The amount of records shown in the list

pageinteger

The page which is going to be shown

order_bystring

The parameter by which the response is ordered.

custom_fieldstring

Filter the response by a custom field value.

order_directionstring

The order direction by which the response is ordered.

referencestring

The reference by which the resource will be filtered.

Headers

x-platform-idstring

Platform ID.

Response

OK

pageinteger nullable
limitinteger nullable
total_number_of_pagesinteger nullable

Changes

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