Skip to content

Images API

List images

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

Sort by format, id, name, size, 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

images:read

Operation id

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

Query parameters

array of strings

Attributes of image 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: equals, any
  • updated_at: greater-than, greater-or-equal, less-than, less-or-equal
  • format: equals, any
  • name: equals, any, contains, starts-with, ends-with
  • size: greater-than, greater-or-equal, less-than, less-or-equal
  • hidden: equals, any

string

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

Pagination guide

integer1 to 100default 20

Default 20, at most 100.

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

      image
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringrequired

      • image_urlstringrequired

      • formatstringrequired

      • sizeintegerrequired

      • hiddenbooleanrequired

      • updated_atstring (date-time)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