Skip to content

Coupons API

List a coupon's codes

GEThttps://email.growthdept.ai/api/coupons/{id}/coupon-codes

Sort by created, ascending or descending (put - in front).

Rate limits

Burst: 75/s

Steady: 750/m

Tier L. See rate limits for how requests are counted.

Scopes

coupon-codes:read

Operation id

get_coupon_codes_for_coupon The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of coupon-code resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

Filter expression.

Filtering guide

Fields and the operators each one takes:

  • expires_at: greater-or-equal, greater-than, less-or-equal, less-than
  • status: equals
  • coupon.id: any, equals
  • profile.id: any, equals

string

From links.next or links.prev of the previous page.

Pagination guide

integer1 to 100default 100

Default 100, at most 100.

Pagination guide

string

Default created.

Sorting guide

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    data: 5 fields
    • typestringrequired

      coupon-code
    • idstringrequired

    • attributesobjectrequired

      attributes: 3 fields
      • unique_codestringcan be null

      • expires_atstring (date-time)can be null

      • statusstringcan be null

        ASSIGNED_TO_PROFILEDELETINGPROCESSINGUNASSIGNEDUSEDVERSION_NOT_ACTIVE
    • relationshipsobject

      relationships: 2 fields
      • couponobject

        coupon: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            coupon
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • profileobject

        profile: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject