Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- lookup_
keysarray of strings Only return personalization designs with the given lookup keys.
- preferencesobject
Only return personalization designs with the given preferences.
- preferences.
is_ defaultboolean Only return the personalization design that’s set as the default. A connected account uses the Connect platform’s default design if no personalization design is set as the default.
- preferences.
is_ platform_ defaultbooleanConnect only Only return the personalization design that is set as the Connect platform’s default. This parameter is only applicable to connected accounts.
- statusenum
Only return personalization designs with the given status.
Possible enum valuesactive
Personalization design can be used to create cards that fulfill immediately.
inactive
Personalization design cannot be used to create cards because it was deactivated.
rejected
Personalization design cannot be used to create cards because it was rejected by design review.
review
Personalization design can be used to create cards but cards will only be fulfilled once the personalization design is activated.
More parameters
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
cards, starting after card starting_
. Each entry in the array is a separate personalization design object. If no more cards are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/issuing/personalization_designs", "has_more": false, "data": [ { "id": "ipcd_Oiw9GXcFRE81LZ", "object": "issuing.personalization_design", "livemode": true, "card_logo": "file_1LzR9L2eZvKYlo2CelTpcvKu", "carrier_text": null, "lookup_key": "my_card_design_lookup_key", "metadata": {}, "name": "My personalization design name", "physical_bundle": "ics_Oiw9ahglMfql0U", "preferences": { "is_default": false }, "rejection_reasons": { "card_logo": [], "carrier_text": [] }, "status": "review" } ]}