API Reference
GuidesAPI ReferenceRoadmap
API Reference
API Reference

šŸ”’ List contact persons V3

get
https://{xentralId}.xentral.biz/api/v3/customers//contactPersons

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: customer:read.

Paginated list of contact persons.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Path Params
string
required
Query Params
filter
array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn

name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith

filter
sort
array

Sort via id, -id, city, -city, zipCode, -zipCode, country and -country. Default sort is -created_at

sort
include
array of strings
include
integer

Number of items per page. Default: 15, Max: 100

integer

Page number.

Responses

401

Unauthorized

403

Forbidden

Updated 30 days ago

Language
Credentials
Bearer
URL
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 30 days ago