v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

List Card Profiles

get/digital_card_profiles

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.instring[]

Filter Digital Card Profiles for those with the specified digital wallet status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Digital Card Profile List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "app_icon_file_id": "file_makxrc67oh9l6sg7w9yc",
      "background_image_file_id": "file_makxrc67oh9l6sg7w9yc",
      "card_description": "Black Card",
      "contact_email": "user@example.com",
      "contact_phone": "+18882988865",
      "contact_website": "https://example.com",
      "created_at": "2020-01-31T23:59:59Z",
      "description": "Corporate logo Apple Pay Card",
      "id": "digital_card_profile_s3puplu90f04xhcwkiga",
      "idempotency_key": null,
      "issuer_name": "National Phonograph Company",
      "status": "active",
      "text_color": {
        "blue": 230,
        "green": 255,
        "red": 189
      },
      "type": "digital_card_profile"
    }
  ],
  "next_cursor": "v57w5d"
}