Searches for gift cards that match a supplied query. The following fields are indexed by search: created_at updated_at disabled_at balance initial_value amount_spent email last_characters Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

https://shopify.com/admin/api/2020-04/gift_cards/search.json

https://shopify.dev/docs/admin-api/rest/reference/plus/giftcard#search-2020-04

Access Token Required: API Key

Query Params

orderstring

The field and direction to order results by. (default: disabled_at DESC)

querystring

The text to search for.

limitstring

The maximum number of results to retrieve. (default: 50, maximum: 250)

fieldsstring

Show only certain fields, specified by a comma-separated list of field names.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://shopify.com/admin/api/2020-04/gift_cards/search.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET