GET api/v1/customers/extended?Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}&searchText={searchText}&archived={archived}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Limit | integer |
None. |
|
| Offset | integer |
None. |
|
| OrderBy | string |
None. |
|
| searchText | string |
Default value is |
|
| archived | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
MultiResultResponseOfExtendedCustomerItemListDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Meta | MetaMultiResult |
None. |
|
| Notifications |
None. |
Response Formats
application/json, text/json
Sample:
{
"meta": {
"limit": 1,
"offset": 2,
"totalResults": 3
},
"notifications": [
{},
{}
],
"results": [
{
"id": "405ff34e-a26f-43d1-8879-78c3e144eb55",
"firstName": "sample string 2",
"lastName": "sample string 3",
"email": "sample string 4",
"emailStatus": 0,
"mobilePhone": "sample string 5",
"gender": 0,
"isMember": true,
"hasCard": true,
"urlPhoto": "sample string 8",
"dni": "sample string 9",
"birthDate": "2026-03-21T21:48:48.5806571+00:00",
"hasProgeny": true,
"cardId": "c268ca3c-68d1-4a07-8e24-a99a697f0e18",
"cardCode": "sample string 11",
"address": "sample string 12",
"city": "sample string 13",
"zipCode": "sample string 14",
"estimatedDateOfBirth": "sample string 15",
"annotations": "sample string 16"
},
{
"id": "405ff34e-a26f-43d1-8879-78c3e144eb55",
"firstName": "sample string 2",
"lastName": "sample string 3",
"email": "sample string 4",
"emailStatus": 0,
"mobilePhone": "sample string 5",
"gender": 0,
"isMember": true,
"hasCard": true,
"urlPhoto": "sample string 8",
"dni": "sample string 9",
"birthDate": "2026-03-21T21:48:48.5806571+00:00",
"hasProgeny": true,
"cardId": "c268ca3c-68d1-4a07-8e24-a99a697f0e18",
"cardCode": "sample string 11",
"address": "sample string 12",
"city": "sample string 13",
"zipCode": "sample string 14",
"estimatedDateOfBirth": "sample string 15",
"annotations": "sample string 16"
}
]
}
application/xml, text/xml
Sample:
<MultiResultResponseOfExtendedCustomerItemListDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
<Meta>
<Limit>1</Limit>
<Offset>2</Offset>
<TotalResults>3</TotalResults>
</Meta>
<Notifications>
<Notification />
<Notification />
</Notifications>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
<d2p1:ExtendedCustomerItemListDto>
<d2p1:Address>sample string 12</d2p1:Address>
<d2p1:Annotations>sample string 16</d2p1:Annotations>
<d2p1:BirthDate>2026-03-21T21:48:48.5806571+00:00</d2p1:BirthDate>
<d2p1:CardCode>sample string 11</d2p1:CardCode>
<d2p1:CardId>c268ca3c-68d1-4a07-8e24-a99a697f0e18</d2p1:CardId>
<d2p1:City>sample string 13</d2p1:City>
<d2p1:Dni>sample string 9</d2p1:Dni>
<d2p1:Email>sample string 4</d2p1:Email>
<d2p1:EmailStatus>Checked</d2p1:EmailStatus>
<d2p1:EstimatedDateOfBirth>sample string 15</d2p1:EstimatedDateOfBirth>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:Gender>Male</d2p1:Gender>
<d2p1:HasCard>true</d2p1:HasCard>
<d2p1:HasProgeny>true</d2p1:HasProgeny>
<d2p1:Id>405ff34e-a26f-43d1-8879-78c3e144eb55</d2p1:Id>
<d2p1:IsMember>true</d2p1:IsMember>
<d2p1:LastName>sample string 3</d2p1:LastName>
<d2p1:MobilePhone>sample string 5</d2p1:MobilePhone>
<d2p1:UrlPhoto>sample string 8</d2p1:UrlPhoto>
<d2p1:ZipCode>sample string 14</d2p1:ZipCode>
</d2p1:ExtendedCustomerItemListDto>
<d2p1:ExtendedCustomerItemListDto>
<d2p1:Address>sample string 12</d2p1:Address>
<d2p1:Annotations>sample string 16</d2p1:Annotations>
<d2p1:BirthDate>2026-03-21T21:48:48.5806571+00:00</d2p1:BirthDate>
<d2p1:CardCode>sample string 11</d2p1:CardCode>
<d2p1:CardId>c268ca3c-68d1-4a07-8e24-a99a697f0e18</d2p1:CardId>
<d2p1:City>sample string 13</d2p1:City>
<d2p1:Dni>sample string 9</d2p1:Dni>
<d2p1:Email>sample string 4</d2p1:Email>
<d2p1:EmailStatus>Checked</d2p1:EmailStatus>
<d2p1:EstimatedDateOfBirth>sample string 15</d2p1:EstimatedDateOfBirth>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:Gender>Male</d2p1:Gender>
<d2p1:HasCard>true</d2p1:HasCard>
<d2p1:HasProgeny>true</d2p1:HasProgeny>
<d2p1:Id>405ff34e-a26f-43d1-8879-78c3e144eb55</d2p1:Id>
<d2p1:IsMember>true</d2p1:IsMember>
<d2p1:LastName>sample string 3</d2p1:LastName>
<d2p1:MobilePhone>sample string 5</d2p1:MobilePhone>
<d2p1:UrlPhoto>sample string 8</d2p1:UrlPhoto>
<d2p1:ZipCode>sample string 14</d2p1:ZipCode>
</d2p1:ExtendedCustomerItemListDto>
</Results>
</MultiResultResponseOfExtendedCustomerItemListDtoaM_S85dVU>