List customers

GET {{baseUrl}}/customers

Retrieve all stored customers.

Pagination options are available via the query parameters.

Please note that the returned list will exclude deleted customers.

Allowed roles : EDITOR and VIEWER

Request Params

KeyDatatypeRequiredDescription
pageTokenstringThe pageToken parameter identifies a specific PageModel in the result set that should be returned.
In an API response, the nextPageToken and prevPageToken properties identify other PageModels that could be retrieved.
limitnumber(Optional query) Limit the number of results.

Accepts a positive integer between 1 and 100. Default: 100

Note that the sever may choose to ignore this parameter and use a lower value.

Example: 20 | | sort | string | | (Optional query) Sorting order |

HEADERS

KeyDatatypeRequiredDescription
tangany-versionnumber(Required) API version
Acceptstring
_tangany-datastring

RESPONSES

status: OK

{"items":[{"authorized":[{"entityId":"cillum deserunt"},{"entityId":"nisi in est"}],"contracts":[{"type":"standard","signedDate":"1951-01-29T22:11:37.811Z","cancelledDate":"1986-12-09T14:40:44.398Z","additionalAttributes":{"quis_51_":"ex aliquip"}}],"id":"78c483d7-5e6d-488b-981c-2ac4bccca2a5","owner":{"entityId":"dolor"},"reason":null,"status":"deleted","additionalAttributes":{"officia_a":"cupidatat et ","nisi40":"est deserunt laboris eu magna"}},{"authorized":[{"entityId":"reprehenderit ut quis"},{"entityId":"veniam consequa"}],"contracts":[{"type":"standard","signedDate":"1969-09-19T17:29:42.273Z","cancelledDate":"1984-08-06T13:11:59.243Z","additionalAttributes":{"non_e23":"do eiusmod","reprehenderit_7":"quis Lorem in non"}}],"id":"78c483d7-5e6d-488b-981c-2ac4bccca2a5","owner":{"entityId":"incididunt lab"},"reason":null,"status":"deleted","additionalAttributes":{"commodo2":"minim consequat adipisicing","sint_093":"pariatur velit"}}],"nextPageToken":"NDg2ODg=","pageInfo":{"totalResults":9192830.835841954,"resultsPerPage":66331446.125199646}}