customers

List customers

get/v3/customers

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/customers
  • Auth: API key in header Authorization

Query parameters

pagenumber double required

Page Number

limitnumber double required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: name (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull lastUpdatedAt (datetime): eq, neq, gt, gte, lt, lte customerCustomFields.defaultValue (string): eq, neq, like, nlike, in, nin, isnull, isnotnull

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=name:eq:value

Response

Get all Customers by filter

payloadV3CustomersGetResponsesContentApplicationJsonSchemaPayload required

Response payload, will be empty when success is false

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

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