List Digital Card Profiles

4 parameters

cursorstringoptional

Return the page of entries after this cursor.

limitintegeroptional

Maximum number of profiles to return. Must be at least 1; defaults to 100 when omitted, and the maximum is 100.

Default:100

status.inarray<string>optional

Filter by one or more profile statuses, encoded as a comma-delimited list: `pending`, `rejected`, `active`, or `archived`.

idempotency_keystringoptional

Filter for the profile with this idempotency key. Must be between 1 and 200 characters.

3 status codes

200Returns a page containing Digital Card Profile objects and a `next_cursor` value for retrieving the next page, or null when there are no more results.

dataarray<DigitalCardProfile>required

The contents of the list.

next_cursorstringrequired

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`.

4XXReturned when the request results in a client error.

5XXReturned when the server encounters an error processing the request.

Error handling

limit must be at least 1 and no greater than 100. Each value in status.in must be pending, rejected, active, or archived, and idempotency_key must be between 1 and 200 characters.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.digitalCardProfiles.list({
  cursor: "example",
  limit: 20,
  statusIn: "example",
  idempotencyKey: "example",
});

{
  "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"
}

Request

Response

Errors