GET api/v1/customers
Get a list of customer, including adress information and contact persons.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Returns a list of CustomerInfo objects.
Collection of CustomerExtDto| Name | Description | Type | Additional information |
|---|---|---|---|
| string |
None. |
||
| Phone | string |
None. |
|
| Fax | string |
None. |
|
| VatNumber | string |
None. |
|
| EanNumber | string |
None. |
|
| Created | date |
None. |
|
| LastUpdated | date |
None. |
|
| ContactPersons | Collection of ContactPersonDto |
None. |
|
| CustomerAddresses | Collection of AddressDto |
None. |
|
| Id | integer |
None. |
|
| ExternalNumber | string |
None. |
|
| Name | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"email": "sample string 1",
"phone": "sample string 2",
"fax": "sample string 3",
"vatNumber": "sample string 4",
"eanNumber": "sample string 5",
"created": "2025-12-08T10:18:19.2765318+01:00",
"lastUpdated": "2025-12-08T10:18:19.2765318+01:00",
"contactPersons": [
{
"contactPersonId": 1,
"customerId": 1,
"externalNumber": "sample string 2",
"lastChanged": "2025-12-08T10:18:19.2765318+01:00",
"email": "sample string 4",
"phone": "sample string 5",
"fax": "sample string 6",
"localPhoneNumber": "sample string 7",
"cellPhoneNumber": "sample string 8",
"company": "sample string 9",
"address": {
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
},
"customer": {
"id": 1,
"externalNumber": "sample string 2",
"name": "sample string 3"
},
"id": 10,
"name": "sample string 11",
"position": "sample string 12"
},
{
"contactPersonId": 1,
"customerId": 1,
"externalNumber": "sample string 2",
"lastChanged": "2025-12-08T10:18:19.2765318+01:00",
"email": "sample string 4",
"phone": "sample string 5",
"fax": "sample string 6",
"localPhoneNumber": "sample string 7",
"cellPhoneNumber": "sample string 8",
"company": "sample string 9",
"address": {
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
},
"customer": {
"id": 1,
"externalNumber": "sample string 2",
"name": "sample string 3"
},
"id": 10,
"name": "sample string 11",
"position": "sample string 12"
}
],
"customerAddresses": [
{
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
},
{
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
}
],
"id": 7,
"externalNumber": "sample string 8",
"name": "sample string 9"
},
{
"email": "sample string 1",
"phone": "sample string 2",
"fax": "sample string 3",
"vatNumber": "sample string 4",
"eanNumber": "sample string 5",
"created": "2025-12-08T10:18:19.2765318+01:00",
"lastUpdated": "2025-12-08T10:18:19.2765318+01:00",
"contactPersons": [
{
"contactPersonId": 1,
"customerId": 1,
"externalNumber": "sample string 2",
"lastChanged": "2025-12-08T10:18:19.2765318+01:00",
"email": "sample string 4",
"phone": "sample string 5",
"fax": "sample string 6",
"localPhoneNumber": "sample string 7",
"cellPhoneNumber": "sample string 8",
"company": "sample string 9",
"address": {
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
},
"customer": {
"id": 1,
"externalNumber": "sample string 2",
"name": "sample string 3"
},
"id": 10,
"name": "sample string 11",
"position": "sample string 12"
},
{
"contactPersonId": 1,
"customerId": 1,
"externalNumber": "sample string 2",
"lastChanged": "2025-12-08T10:18:19.2765318+01:00",
"email": "sample string 4",
"phone": "sample string 5",
"fax": "sample string 6",
"localPhoneNumber": "sample string 7",
"cellPhoneNumber": "sample string 8",
"company": "sample string 9",
"address": {
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
},
"customer": {
"id": 1,
"externalNumber": "sample string 2",
"name": "sample string 3"
},
"id": 10,
"name": "sample string 11",
"position": "sample string 12"
}
],
"customerAddresses": [
{
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
},
{
"addressId": 1,
"name": "sample string 2",
"address1": "sample string 3",
"address2": "sample string 4",
"zipCode": "sample string 5",
"city": "sample string 6",
"country": "sample string 7",
"countryId": 1,
"attention": "sample string 8"
}
],
"id": 7,
"externalNumber": "sample string 8",
"name": "sample string 9"
}
]
application/xml, text/xml
Sample:
<ArrayOfCustomerExtDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Workpilot.ServiceLayer.Models">
<CustomerExtDto>
<ExternalNumber>sample string 8</ExternalNumber>
<Id>7</Id>
<Name>sample string 9</Name>
<ContactPersons>
<ContactPersonDto>
<Name>sample string 11</Name>
<Position>sample string 12</Position>
<id>10</id>
<Address>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</Address>
<CellPhoneNumber>sample string 8</CellPhoneNumber>
<Company>sample string 9</Company>
<ContactPersonId>1</ContactPersonId>
<Customer>
<ExternalNumber>sample string 2</ExternalNumber>
<Id>1</Id>
<Name>sample string 3</Name>
</Customer>
<CustomerId>1</CustomerId>
<Email>sample string 4</Email>
<ExternalNumber>sample string 2</ExternalNumber>
<Fax>sample string 6</Fax>
<LastChanged>2025-12-08T10:18:19.2765318+01:00</LastChanged>
<LocalPhoneNumber>sample string 7</LocalPhoneNumber>
<Phone>sample string 5</Phone>
</ContactPersonDto>
<ContactPersonDto>
<Name>sample string 11</Name>
<Position>sample string 12</Position>
<id>10</id>
<Address>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</Address>
<CellPhoneNumber>sample string 8</CellPhoneNumber>
<Company>sample string 9</Company>
<ContactPersonId>1</ContactPersonId>
<Customer>
<ExternalNumber>sample string 2</ExternalNumber>
<Id>1</Id>
<Name>sample string 3</Name>
</Customer>
<CustomerId>1</CustomerId>
<Email>sample string 4</Email>
<ExternalNumber>sample string 2</ExternalNumber>
<Fax>sample string 6</Fax>
<LastChanged>2025-12-08T10:18:19.2765318+01:00</LastChanged>
<LocalPhoneNumber>sample string 7</LocalPhoneNumber>
<Phone>sample string 5</Phone>
</ContactPersonDto>
</ContactPersons>
<Created>2025-12-08T10:18:19.2765318+01:00</Created>
<CustomerAddresses>
<AddressDto>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</AddressDto>
<AddressDto>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</AddressDto>
</CustomerAddresses>
<EanNumber>sample string 5</EanNumber>
<Email>sample string 1</Email>
<Fax>sample string 3</Fax>
<LastUpdated>2025-12-08T10:18:19.2765318+01:00</LastUpdated>
<Phone>sample string 2</Phone>
<VatNumber>sample string 4</VatNumber>
</CustomerExtDto>
<CustomerExtDto>
<ExternalNumber>sample string 8</ExternalNumber>
<Id>7</Id>
<Name>sample string 9</Name>
<ContactPersons>
<ContactPersonDto>
<Name>sample string 11</Name>
<Position>sample string 12</Position>
<id>10</id>
<Address>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</Address>
<CellPhoneNumber>sample string 8</CellPhoneNumber>
<Company>sample string 9</Company>
<ContactPersonId>1</ContactPersonId>
<Customer>
<ExternalNumber>sample string 2</ExternalNumber>
<Id>1</Id>
<Name>sample string 3</Name>
</Customer>
<CustomerId>1</CustomerId>
<Email>sample string 4</Email>
<ExternalNumber>sample string 2</ExternalNumber>
<Fax>sample string 6</Fax>
<LastChanged>2025-12-08T10:18:19.2765318+01:00</LastChanged>
<LocalPhoneNumber>sample string 7</LocalPhoneNumber>
<Phone>sample string 5</Phone>
</ContactPersonDto>
<ContactPersonDto>
<Name>sample string 11</Name>
<Position>sample string 12</Position>
<id>10</id>
<Address>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</Address>
<CellPhoneNumber>sample string 8</CellPhoneNumber>
<Company>sample string 9</Company>
<ContactPersonId>1</ContactPersonId>
<Customer>
<ExternalNumber>sample string 2</ExternalNumber>
<Id>1</Id>
<Name>sample string 3</Name>
</Customer>
<CustomerId>1</CustomerId>
<Email>sample string 4</Email>
<ExternalNumber>sample string 2</ExternalNumber>
<Fax>sample string 6</Fax>
<LastChanged>2025-12-08T10:18:19.2765318+01:00</LastChanged>
<LocalPhoneNumber>sample string 7</LocalPhoneNumber>
<Phone>sample string 5</Phone>
</ContactPersonDto>
</ContactPersons>
<Created>2025-12-08T10:18:19.2765318+01:00</Created>
<CustomerAddresses>
<AddressDto>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</AddressDto>
<AddressDto>
<Address1>sample string 3</Address1>
<Address2>sample string 4</Address2>
<AddressId>1</AddressId>
<Attention>sample string 8</Attention>
<City>sample string 6</City>
<Country>sample string 7</Country>
<CountryId>1</CountryId>
<Name>sample string 2</Name>
<ZipCode>sample string 5</ZipCode>
</AddressDto>
</CustomerAddresses>
<EanNumber>sample string 5</EanNumber>
<Email>sample string 1</Email>
<Fax>sample string 3</Fax>
<LastUpdated>2025-12-08T10:18:19.2765318+01:00</LastUpdated>
<Phone>sample string 2</Phone>
<VatNumber>sample string 4</VatNumber>
</CustomerExtDto>
</ArrayOfCustomerExtDto>