Skip to content

Tracking Settings API

Get the account's tracking settings

GEThttps://email.growthdept.ai/api/tracking-settings

A list holding the account's one tracking setting: UTM defaults for campaigns and flows.

Rate limits

Burst: 10/s

Steady: 150/m

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

Scopes

tracking-settings:read

Operation id

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

Query parameters

array of strings

Attributes of tracking-setting resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

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

Pagination 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: 4 fields
    • typestringrequired

      tracking-setting
    • idstringrequired

    • attributesobjectrequired

      attributes: 7 fields
      • auto_add_parametersbooleanrequired

      • utm_sourceobjectrequired

        utm_source: 2 fields
        • flowone ofcan be null

          One option: FlowTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
          One option: FlowTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

        • campaignone ofcan be null

          One option: CampaignTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            Show 13 allowed values
            campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
          One option: CampaignTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

      • utm_mediumobjectrequired

        utm_medium: 2 fields
        • flowone ofcan be null

          One option: FlowTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
          One option: FlowTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

        • campaignone ofcan be null

          One option: CampaignTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            Show 13 allowed values
            campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
          One option: CampaignTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

      • utm_campaignobjectcan be null

        utm_campaign: 2 fields
        • flowone ofcan be null

          One option: FlowTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
          One option: FlowTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

        • campaignone ofcan be null

          One option: CampaignTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            Show 13 allowed values
            campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
          One option: CampaignTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

      • utm_idobjectcan be null

        utm_id: 2 fields
        • flowone ofcan be null

          One option: FlowTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
          One option: FlowTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

        • campaignone ofcan be null

          One option: CampaignTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            Show 13 allowed values
            campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
          One option: CampaignTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

      • utm_termobjectcan be null

        utm_term: 2 fields
        • flowone ofcan be null

          One option: FlowTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
          One option: FlowTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

        • campaignone ofcan be null

          One option: CampaignTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            Show 13 allowed values
            campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
          One option: CampaignTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

      • custom_parametersarray of objectscan be null

        custom_parameters: 3 fields
        • flowone ofcan be null

          One option: FlowTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            email_subjectflow_idflow_namelink_alt_textmessage_namemessage_name_idmessage_typeprofile_external_idprofile_id
          One option: FlowTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

        • campaignone ofcan be null

          One option: CampaignTrackingSettingDynamicParam
          • typestringrequired

            dynamic
          • valuestringrequired

            Show 13 allowed values
            campaign_idcampaign_namecampaign_name_idcampaign_name_send_dayemail_subjectgroup_idgroup_namegroup_name_idlink_alt_textmessage_typeprofile_external_idprofile_idvariation_name
          One option: CampaignTrackingSettingStaticParam
          • typestringrequired

            static
          • valuestringrequired

        • namestringrequired

    • 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