GET /v2/gift-cards
Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards.
Servers
- https://connect.squareup.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
customer_id |
String | No |
If a value is provided, returns only the gift cards linked to the specified customer |
limit |
Integer | No |
If a value is provided, it returns only that number of results per page. The maximum number of results allowed per page is 50. The default value is 30. |
type |
String | No |
If a type is provided, gift cards of this type are returned (see GiftCardType). If no type is provided, it returns gift cards of all types. |
state |
String | No |
If the state is provided, it returns the gift cards in the specified state (see GiftCardStatus). Otherwise, it returns the gift cards of all states. |
cursor |
String | No |
A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. If a cursor is not provided, it returns the first page of the results. For more information, see Pagination. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.