v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

List Physical Card Profiles

get/physical_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 Physical Card Profiles for those with the specified 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

Physical 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": [
    {
      "back_image_file_id": "file_makxrc67oh9l6sg7w9yc",
      "carrier_image_file_id": "file_makxrc67oh9l6sg7w9yc",
      "contact_phone": "+16505046304",
      "created_at": "2020-01-31T23:59:59Z",
      "creator": "user",
      "description": "Corporate logo card",
      "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
      "front_text": null,
      "id": "physical_card_profile_m534d5rn9qyy9ufqxoec",
      "idempotency_key": null,
      "is_default": false,
      "program_id": "program_i2v2os4mwza1oetokh9i",
      "status": "active",
      "type": "physical_card_profile"
    }
  ],
  "next_cursor": "v57w5d"
}