GET api/v1/cards?customerId={customerId}&Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId | globally unique identifier |
Required |
|
| Limit | integer |
None. |
|
| Offset | integer |
None. |
|
| OrderBy | string |
None. |
Body Parameters
None.
Response Information
Resource Description
MultiResultResponseOfCardDto| 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": "cb69c8c7-db36-4c9e-8afe-1669547e8198",
"code": "sample string 1",
"stage": 0,
"expirationDate": "2026-06-22T07:57:27.6897204+00:00",
"isArchived": true,
"cardTypeCode": "sample string 3",
"cardTypeName": "sample string 4",
"customerId": "51c151db-4108-46c6-81ff-dd1620b6447f",
"relativeId": "715042b8-2ac4-45b3-8a23-dcb1af86bb05",
"relativeFirstName": "sample string 6",
"relativeLastName": "sample string 7",
"creationDate": "2026-06-22T07:57:27.6897204+00:00"
},
{
"id": "cb69c8c7-db36-4c9e-8afe-1669547e8198",
"code": "sample string 1",
"stage": 0,
"expirationDate": "2026-06-22T07:57:27.6897204+00:00",
"isArchived": true,
"cardTypeCode": "sample string 3",
"cardTypeName": "sample string 4",
"customerId": "51c151db-4108-46c6-81ff-dd1620b6447f",
"relativeId": "715042b8-2ac4-45b3-8a23-dcb1af86bb05",
"relativeFirstName": "sample string 6",
"relativeLastName": "sample string 7",
"creationDate": "2026-06-22T07:57:27.6897204+00:00"
}
]
}
application/xml, text/xml
Sample:
<MultiResultResponseOfCardDtoaM_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:CardDto>
<d2p1:CardTypeCode>sample string 3</d2p1:CardTypeCode>
<d2p1:CardTypeName>sample string 4</d2p1:CardTypeName>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:CreationDate>2026-06-22T07:57:27.6897204+00:00</d2p1:CreationDate>
<d2p1:CustomerId>51c151db-4108-46c6-81ff-dd1620b6447f</d2p1:CustomerId>
<d2p1:ExpirationDate>2026-06-22T07:57:27.6897204+00:00</d2p1:ExpirationDate>
<d2p1:Id>cb69c8c7-db36-4c9e-8afe-1669547e8198</d2p1:Id>
<d2p1:IsArchived>true</d2p1:IsArchived>
<d2p1:RelativeFirstName>sample string 6</d2p1:RelativeFirstName>
<d2p1:RelativeId>715042b8-2ac4-45b3-8a23-dcb1af86bb05</d2p1:RelativeId>
<d2p1:RelativeLastName>sample string 7</d2p1:RelativeLastName>
<d2p1:Stage>Requested</d2p1:Stage>
</d2p1:CardDto>
<d2p1:CardDto>
<d2p1:CardTypeCode>sample string 3</d2p1:CardTypeCode>
<d2p1:CardTypeName>sample string 4</d2p1:CardTypeName>
<d2p1:Code>sample string 1</d2p1:Code>
<d2p1:CreationDate>2026-06-22T07:57:27.6897204+00:00</d2p1:CreationDate>
<d2p1:CustomerId>51c151db-4108-46c6-81ff-dd1620b6447f</d2p1:CustomerId>
<d2p1:ExpirationDate>2026-06-22T07:57:27.6897204+00:00</d2p1:ExpirationDate>
<d2p1:Id>cb69c8c7-db36-4c9e-8afe-1669547e8198</d2p1:Id>
<d2p1:IsArchived>true</d2p1:IsArchived>
<d2p1:RelativeFirstName>sample string 6</d2p1:RelativeFirstName>
<d2p1:RelativeId>715042b8-2ac4-45b3-8a23-dcb1af86bb05</d2p1:RelativeId>
<d2p1:RelativeLastName>sample string 7</d2p1:RelativeLastName>
<d2p1:Stage>Requested</d2p1:Stage>
</d2p1:CardDto>
</Results>
</MultiResultResponseOfCardDtoaM_S85dVU>