Skip to content

Events API

List events

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

Events in the account, newest first unless sort says otherwise.

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

Rate limits

Burst: 350/s

Steady: 3500/m

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

Scopes

events:read

Operation id

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

Query parameters

array of strings

Attributes of attribution resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of event resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of metric resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

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

  • metric_id: equals
  • profile_id: equals
  • properties.<key>: equals
  • datetime: greater-than, greater-or-equal, less-than, less-or-equal
  • timestamp: 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 1000default 200

Default 200, at most 1000.

Pagination guide

string

Default -datetime.

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

      event
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • timestampintegercan be null

      • event_propertiesobjectcan be null

      • datetimestring (date-time)can be null

      • uuidstringcan be null

    • relationshipsobject

      relationships: 3 fields
      • profileobject

        profile: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • metricobject

        metric: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            metric
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • attributionsobject

        attributions: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            attribution
          • 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: MetricResponseObjectResource
    • typestringrequired

      metric
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • namestringcan be null

      • createdstringcan be null

      • updatedstringcan be null

      • integrationobjectcan be null

    • relationshipsobject

      relationships: 1 field
      • flow-triggersobject

        flow-triggers: 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: ProfileResponseObjectResource
    • typestringrequired

      profile
    • idstringcan be null

    • attributesobjectrequired

      attributes: 14 fields
      • emailstringcan be null

      • phone_numberstringcan be null

      • external_idstringcan be null

      • first_namestringcan be null

      • last_namestringcan be null

      • organizationstringcan be null

      • localestringcan be null

      • titlestringcan be null

      • imagestringcan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • last_event_datestring (date-time)can be null

      • locationobjectcan be null

        location: 10 fields
        • address1stringcan be null

        • address2stringcan be null

        • citystringcan be null

        • countrystringcan be null

        • latitudeone ofcan be null

          One option: string

          No fields.

          One option: number

          No fields.

        • longitudeone ofcan be null

          One option: string

          No fields.

          One option: number

          No fields.

        • regionstringcan be null

        • zipstringcan be null

        • timezonestringcan be null

        • ipstringcan be null

      • propertiesobjectcan be null

    • relationshipsobject

      relationships: 3 fields
      • 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

      • push-tokensobject

        push-tokens: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            push-token
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

    One option: AttributionResponseObjectResource
    • typestringrequired

      attribution
    • idstringrequired

    • relationshipsobject

      relationships: 7 fields
      • eventobject

        event: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            event
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • attributed-eventobject

        attributed-event: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            event
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • campaignobject

        campaign: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • campaign-messageobject

        campaign-message: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            campaign-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flowobject

        flow: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-messageobject

        flow-message: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            flow-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-message-variationobject

        flow-message-variation: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            flow-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