Skip to content

Get Gift Cards
Alpha

Request

Get all gift cards for the company.

Security
OAuth2(Required scopes: gift-card.read)
Query
cursorstring

Pagination cursor for fetching the next page of results. Omit or pass an empty string to start from the beginning of the list.

limitinteger, (int32), [ 1 .. 100 ]

Maximum number of items to return per page. Defaults to 100, maximum 100.

Default:100
statusstring(GiftCardStatus)

Restrict the result to gift cards with the given status.

Enum:"ACTIVE""SPENT""EXPIRED""VOIDED""UNKNOWN"
curl -i -X GET \
  'https://api.understory.io/v1/gift-cards?cursor=string&limit=100&status=ACTIVE' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
nextstring

Cursor for the next page of results. An empty string or absent value indicates the end of the list.

itemsArray of objects(GiftCard)

The list of gift cards on the current page.

Response
{
  "next": "string",
  "items": [
    { … }
  ]
}