<- Loyalty API

Loyalty API

List loyalty promotions

GET

 /v2/loyalty/programs/{program_id}/promotions

Lists the loyalty promotions associated with a loyalty program.

Results are sorted by the created_at date in descending order (newest to oldest).

Permissions:LOYALTY_READ

Guide

List loyalty promotions

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

program_id

string

Required

The ID of the base loyalty program. To get the program ID, call RetrieveLoyaltyProgram using the main keyword.

Link to section

Query parameters

Link to section

status

string

The status to filter the results by. If a status is provided, only loyalty promotions with the specified status are returned. Otherwise, all loyalty promotions associated with the loyalty program are returned.

Show values
Link to section

cursor

string

The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

Link to section

limit

integer(32-bit)

The maximum number of results to return in a single paged response. The minimum value is 1 and the maximum value is 30. The default value is 30. For more information, see Pagination.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

loyalty_promotions

The retrieved loyalty promotions.

Show attributes
Link to section

cursor

string

The cursor to use in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see Pagination.