Skip to content

Campaigns API

List campaigns

GEThttps://email.growthdept.ai/api/campaigns

Sort by created_at, id, name, updated_at, ascending or descending (put - in front).

Rate limits

Burst: 10/s

Steady: 150/m

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

Scopes

campaigns:read

Operation id

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

Query parameters

array of strings

Attributes of campaign-audience resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of campaign-message resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of campaign resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of tag 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:

  • id: any
  • name: contains
  • archived: equals
  • builder: equals
  • created_at: greater-than, greater-or-equal, less-than, less-or-equal
  • updated_at: greater-than, greater-or-equal, less-than, less-or-equal
  • messages.channel: equals
  • status: any, equals
  • scheduled_at: greater-than, greater-or-equal, less-than, less-or-equal

array of strings

Related resources to side-load.

Includes guide

Pick values to add them to the request:

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_at.

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

      campaign
    • idstringrequired

    • attributesobjectrequired

      attributes: 3 fields
      • created_atstring (date-time)can be null

      • updated_atstring (date-time)can be null

      • definitionobjectrequired

        definition: 6 fields
        • namestringcan be null

        • builderstringcan be null

        • archivedbooleancan be null

        • colorstringcan be null

        • descriptionstringcan be null

        • send_settingsobjectcan be null

          send_settings: 5 fields
          • send_timezonestringcan be null

          • send_strategystringcan be null

            content_variationcontent_variation_local_timezonepersonalized_send_time_optimizationsend_time_optimizationsimplethrottledtimezonevariationvariation_per_second_throttledvariation_send_time
          • send_passed_rltz_immediatelybooleancan be null

          • exit_condition_enabledbooleancan be null

          • exit_condition_conversion_metric_idstringcan be null

    • relationshipsobject

      relationships: 3 fields
      • campaign-audiencesobject

        campaign-audiences: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            campaign-audience
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • campaign-messagesobject

        campaign-messages: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            campaign-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • tagsobject

        tags: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            tag
          • 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

  • includedarray of objects

    One option: TagResponseObjectResource
    • typestringrequired

      tag
    • idstringrequired

    • attributesobjectrequired

      attributes: 1 field
      • namestringrequired

    • relationshipsobject

      relationships: 5 fields
      • tag-groupobject

        tag-group: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            tag-group
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • listsobject

        lists: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            list
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • segmentsobject

        segments: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            segment
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • campaignsobject

        campaigns: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            campaign
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flowsobject

        flows: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

    One option: MessageResponseObjectResource
    • typestringrequired

      campaign-message
    • idstringrequired

    • attributesobjectrequired

      attributes: 3 fields
      • createdstring (date-time)required

      • updatedstring (date-time)required

      • definitionobjectrequired

        definition: 5 fields
        • namestringcan be null

        • statusstringcan be null

          cancelleddraftscheduledsendingsent
        • tracking_optionsobjectcan be null

          tracking_options: 4 fields
          • is_add_utmbooleancan be null

          • is_tracking_clicksbooleancan be null

          • is_tracking_opensbooleancan be null

          • tracking_paramsarray of objectscan be null

            One option: StaticMessageTrackingParam
            • typestring

              static
            • namestringrequired

            • valuestringrequired

            One option: DynamicMessageTrackingParam
            • typestring

              dynamic
            • namestringrequired

            • valuestringrequired

        • send_optionsobjectcan be null

          send_options: 7 fields
          • send_timestring (date-time)can be null

          • send_timesobjectcan be null

          • send_strategystringcan be null

            ab_send_time_testcontent_variationcontent_variation_local_timezonelocal_timezonepersonalized_send_time_optimizationsend_time_optimizationstaticthrottledvariation_per_second_throttled
          • recipient_percentageintegercan be null

          • throttling_typestringcan be null

            nonethrottle-for-campaignsthrottle-for-campaigns-and-flowsthrottle-for-flows
          • throttle_unitstringcan be null

            hourminute
          • is_ignoring_unsubscribesbooleancan be null

        • ab_testobjectcan be null

          ab_test: 3 fields
          • winner_metricstringcan be null

            clicks_uniqueopens_uniqueplaced_orders_unique
          • winner_percentageintegercan be null

          • winner_wait_hoursintegercan be null

    • relationshipsobject

      relationships: 3 fields
      • campaignobject

        campaign: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • campaign-audienceobject

        campaign-audience: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign-audience
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • campaign-variationsobject

        campaign-variations: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            campaign-variation
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

    One option: AudienceResponseObjectResource
    • typestringrequired

      campaign-audience
    • idstringrequired

    • attributesobjectrequired

      attributes: 3 fields
      • createdstring (date-time)required

      • updatedstring (date-time)required

      • definitionobjectrequired

        definition: 4 fields
        • namestringcan be null

        • includedarray of stringscan be null

        • excludedarray of stringscan be null

        • priorityintegercan be null

    • relationshipsobject

      relationships: 2 fields
      • campaignobject

        campaign: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • campaign-messagesobject

        campaign-messages: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            campaign-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

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