Get Coupon Codes
GET {{baseUrl}}/api/coupon-codes/
Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles.
A coupon/coupons or a profile/profiles must be provided as required filter params.
Rate limits:
Burst: 350/s
Steady: 3500/m
Scopes:
coupon-codes:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[coupon-code] | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | |
fields[coupon] | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>expires_at: greater-or-equal, greater-than, less-or-equal, less-than<br>status: equals<br>coupon.id: any, equals<br>profile.id: any, equals | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#relationships | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2024-02-15/reference/api-overview#pagination |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"coupon-code","id":"\u003cstring\u003e","attributes":{"unique_code":"\u003cstring\u003e","expires_at":"\u003cdateTime\u003e","status":"ASSIGNED_TO_PROFILE"},"links":{"self":"\u003curi\u003e"},"relationships":{"coupon":{"data":{"type":"coupon","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"profile":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"coupon-code","id":"\u003cstring\u003e","attributes":{"unique_code":"\u003cstring\u003e","expires_at":"\u003cdateTime\u003e","status":"DELETING"},"links":{"self":"\u003curi\u003e"},"relationships":{"coupon":{"data":{"type":"coupon","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"profile":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"},"included":[{"type":"coupon","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","description":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"coupon","id":"\u003cstring\u003e","attributes":{"external_id":"\u003cstring\u003e","description":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}}]}