Skip to content

Lists API

List lists

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

Sort by created, id, name, updated, 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

lists:read

Operation id

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

Query parameters

array of strings

Attributes of flow resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

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

  • name: equals, any
  • id: equals, any
  • created: greater-than
  • updated: greater-than

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 10default 10

Default 10, at most 10.

Pagination guide

string

Default id.

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

      list
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • namestringcan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • opt_in_processstringcan be null

        double_opt_insingle_opt_in
    • relationshipsobject

      relationships: 3 fields
      • profilesobject

        profiles: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

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

      • 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

  • 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: FlowResponseObjectResource
    • typestringrequired

      flow
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringcan be null

      • statusstringcan be null

      • archivedbooleancan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • trigger_typestringcan be null

        Added to ListDate BasedLow InventoryMetricPrice DropUnconfigured
    • relationshipsobject

      relationships: 2 fields
      • flow-actionsobject

        flow-actions: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

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

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