GET /v2/gift-cards/activities
Lists gift card activities. By default, you get gift card activities for all gift cards in the seller's account. You can optionally specify query parameters to filter the list. For example, you can get a list of gift card activities for a gift card, for all gift cards in a specific region, or for activities within a time window.
Servers
- https://connect.squareup.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
gift_card_id |
String | No |
If you provide a gift card ID, the endpoint returns activities that belong to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller. |
location_id |
String | No |
If you provide a location ID, the endpoint returns gift card activities for that location. Otherwise, the endpoint returns gift card activities for all locations. |
begin_time |
String | No |
The timestamp for the beginning of the reporting period, in RFC 3339 format. Inclusive. Default: The current time minus one year. |
sort_order |
String | No |
The order in which the endpoint returns the activities, based on
|
limit |
Integer | No |
If you provide a limit value, the endpoint returns the specified number of results (or less) per page. A maximum value is 100. The default value is 50. |
type |
String | No |
If you provide a type, the endpoint returns gift card activities of this type. Otherwise, the endpoint returns all types of gift card activities. |
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 you do not provide the cursor, the call returns the first page of the results. |
end_time |
String | No |
The timestamp for the end of the reporting period, in RFC 3339 format. Inclusive. Default: The current time. |
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.