GET
/
v1
/
images
curl --request GET \
  --url https://api.img-processing.com/v1/images \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "image_s56zyk2y28277cjoz6pwchvo",
      "name": "a",
      "url": null,
      "width": 828,
      "height": 1841,
      "format": "jpeg",
      "size": 2122031,
      "created_at": "2024-08-07T12:40:55.712Z"
    },
    {
      "id": "image_sf33syiyk8mqziwss8kegiy3",
      "name": "b",
      "url": null,
      "width": 828,
      "height": 1841,
      "format": "jpeg",
      "size": 2122031,
      "created_at": "2024-08-07T12:39:18.889Z"
    },
    {
      "id": "image_h7lvd99bfd7mz0wph00mq0du",
      "name": "c",
      "url": null,
      "width": 828,
      "height": 1841,
      "format": "jpeg",
      "size": 2122031,
      "created_at": "2024-08-07T12:39:01.598Z"
    }
  ],
  "links": {
    "previous": "https://api.img-processing.com/v1/images?take=3&from=image_x9kyka4tbrm90b4hk5dwfgh3",
    "next": "https://api.img-processing.com/v1/images?take=3&from=image_oy09072689xswn0o1cjf8k35"
  }
}

​
Description

This endpoint allows you to retrieve a list of all the images created by the user. The images are returned in descending order of creation date, with the most recent images first in the list.

Images are paginated, following the pagination rules.

This endpoint only returns the images created in the stage (test/live) associated with the API key used in the request.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Query Parameters

​
take
number

The number of images to return. Must be between 1 and 100. Defaults to 10.

Required range: 1 <= x <= 100
​
from
string

The image ID to start from when listing images. If provided, the list will include images created after this ID. Must be a valid image ID.

Response

200
application/json

The API will return the Image object in the response body.

The PaginatedImageResponse object represents a paginated response containing a list of images. It includes an array of Image objects and links to navigate through the pages of results.

​
data
Image Object · object[]
required

An array of Image objects representing the images in the current page.

​
links
object
required