List all gift card recipients

How to fetch a collection of gift card recipients via API

To fetch a collection of gift card recipients, send a GET request to the /api/gift_card_recipients endpoint.

Request

GET https://yourdomain.commercelayer.io/api/gift_card_recipients

Example

The following request fetches a collection of gift card recipients:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/gift_card_recipients/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of gift card recipients can be sorted by the following fields:

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

Filterable fields

The list of gift card recipients can be filtered by the following fields:

Attributes

  • email

  • first_name

  • last_name

  • id

  • created_at

  • updated_at

  • reference

  • reference_origin

  • metadata

Relationships

  • customer

  • attachments

Last updated