v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Customers

List customer contacts

get/v3/customers/{id}/contacts

Path parameters

idstring required

Query parameters

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

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

Fields: firstName (string): eq, neq, like, nlike, in, nin, isnull, isnotnull lastName (string): eq, neq, like, nlike, in, nin, isnull, isnotnull email (string): eq, neq, like, nlike, in, nin, isnull, isnotnull isPrimaryContact (boolean): eq isCCEmail (boolean): eq

Example: filter=firstName:eq:value

Response

Get all Customers by filter

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "isPrimaryContact": true
      }
    ]
  }
}