GET api/v1/customers

List customer

Request Information

URI Parameters

Name	Description	Type	Additional information
Filter	Filter records	ListCustomerV1Filter	None.
Select	Select columns	Collection of ListCustomerV1Select	Default value: All Example value: Name, Description Unique items
Sort	Sort records Sort by the first column, then by the second column, and so on	Collection of ListCustomerV1Sort	Default value: Name Example value: Name Max items: 3 Unique items
PageNumber	Page number	integer (32 bits)	Default value: 1 Example value: 1 Range: inclusive between 1 and 2147483647
PageSize	Number of records per page	integer (32 bits)	Default value: 10 Example value: 10 Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of customers

ListCustomerV1Response

Name	Description	Type	Additional information
Customers	List of customers	Collection of ListCustomerV1ResponseCustomer	None.
Total	Total number of records matching the request	integer (32 bits)	Required Example value: 42 Range: inclusive between 0 and 2147483647

Name

Description

Type

Additional information

Customers

List of customers

Collection of ListCustomerV1ResponseCustomer

None.

Total

Total number of records matching the request

integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:

{
  "Customers": [
    {
      "CustomerId": "3e00a05a-ff81-4523-80c1-f6837843c7a5",
      "Name": "Building Inspectors N.V.",
      "Description": "Building Inspectors Group",
      "Number": "18423",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    },
    {
      "CustomerId": "3e00a05a-ff81-4523-80c1-f6837843c7a5",
      "Name": "Building Inspectors N.V.",
      "Description": "Building Inspectors Group",
      "Number": "18423",
      "CreateDate": "2018-12-31T21:59:59.999+00:00",
      "LastUpdateDate": "2018-12-31T21:59:59.999+00:00"
    }
  ],
  "Total": 42
}