POST /v2/loyalty/rewards/search
Searches for loyalty rewards in a loyalty account.
In the current implementation, the endpoint supports search by the reward status.
If you know a reward ID, use the RetrieveLoyaltyReward endpoint.
Search results are sorted by updated_at in descending order.
Servers
- https://connect.squareup.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
query |
Object | No |
The set of search requirements. |
query.loyalty_account_id |
String | Yes |
The ID of the loyalty account to which the loyalty reward belongs. |
query.status |
String | No |
The status of the loyalty reward. |
limit |
Integer | No |
The maximum number of results to return in the response. |
cursor |
String | No |
A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. 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.