Sign in

v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB
Images

List images

With this endpoint you can get a paginated list of images for a brand.

Sorting: Supported sort fields: createdAt (default), name Supported directions: asc, desc (default)

Filtering: Use nameContains to filter images by name (case-insensitive, partial match)

Pagination: This endpoint uses cursor-based pagination for efficient traversal of large datasets.

  • Use the cursors.after value from the response to get the next page
  • Use the cursors.before value from the response to get the previous page
  • The hasMore field indicates if more results are available
  • Do not use both after and before parameters simultaneously
  • Maximum page size is 250 items (default 100)

Scopes: images.read

get/images

Query parameters

limitinteger

Number of images per page (1-250)

afterstring

Cursor for next page (base64-encoded, from previous response)

beforestring

Cursor for previous page (base64-encoded, from previous response)

sort'createdAt' | 'name'

Field to sort by

direction'asc' | 'desc'

Sort order

nameContainsstring

Filter images by name (partial match, case-insensitive, max 200 characters)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

List of images

Example response

{
  "images": [
    {
      "createdAt": "2026-01-15T10:30:00Z",
      "height": 1080,
      "id": "507f1f77bcf86cd799439011",
      "name": "my-image",
      "size": 102400,
      "type": "image/jpeg",
      "url": "https://cdn.example.com/image.jpg",
      "width": 1920
    }
  ],
  "paging": {
    "cursors": {
      "after": "eyJpZCI6ImNhbXAtNDU2In0",
      "before": "eyJpZCI6ImNhbXAtMTIzIn0"
    },
    "hasMore": true,
    "limit": 50
  }
}