Sub-resources of card-types

All available methods for the sub-resources of the resource card-types.


Get a collection of cards

Get information about all cards by card types resource
[badge-blue GET] /card-types/{card_type_id}/cards

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
customer_id string The unique id for the customer No
is_valid boolean If in validity range - true, before or after validity range - false No

Path parameters

Parameter name Type Description Mandatory (Yes/No)
card_type_id string The unique id for the card type Yes

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
cards Card[] List of cards
total_items integer Count of all found cards