Get all customers

Prev Next
Get
/v2/network/customers

Returns the list of all customers.
This endpoint is authorized to organizations only, and allows retrieving the list of customers specifying:
 - One or more conditions based on properties (all conditions are in AND).
 - The sorting criteria (also multiple).
 - The paging configuration.

The list of results is limited to only those customers authorized to the user's parent organization.
Required permissions: READ_ALL_CUSTOMERS.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
searchText
string

The search text used to filter objects (requires searchField parameter).
Use '*' for variants: starts with (foo*), contains (*foo*) or ends with (*foo).

Maximum1.0
Example*foo*
searchField
string

The name of the field in which to verify the search text.

Maximum-1.0
Examplename
code
string

Condition on customer code.
For more details on predicates, see the payload common concepts article.

ExampleC000123
name
string

Condition on name property.
For more details on predicates, see the payload common concepts article.

Exampleeq;FooBar
country
string

Condition on country.
For more details on predicates, see the payload common concepts article.

ExampleItaly
PROPERTY_NAME
string

Condition on object property.
For more details on predicates, see the payload common concepts article.

Exampleproperties.propABC=eq;XYZ
size
integer

The number of elements to retrieve for the current page.

Minimum1.0
Example200
page
integer

The page number to retrieve (zero-based).

Minimum0.0
Example0
sort
string

The sorting criteria based on object properties.

Minimum0.0
Examplename,ASC
Responses
200

Successful operation.

Expand All
object
content
Array of object (Customer)
object

The bean providing customer details.

id
string

The customer object identifier.

name
string

The name of the customer which could be a personal name or a business name.

country
string

The country the customer belongs to.

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
creationTimestamp
integer (int64)

The timestamp at which the object was created.

firstAccessTimestamp
integer (int64)

The timestamp at which a client's user first logged in.

lastAccessTimestamp
integer (int64)

The timestamp at which a client's user last logged in.

first
boolean

The flag indicating whether the page is the first one.

last
boolean

The flag indicating whether the last page has been reached.

totalPages
integer

The total number of pages.

totalElements
integer

The total number of elements.

sort
string

The current sorting criteria.

numberOfElements
integer

The number of elements in this page.

size
integer

The requested page size.

number
integer

The number of the page (zero-based).

Minimum0.0
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error