# List Images

`GET https://api.inboxjot.com/v1/images`

Lists the images of the media library, newest first. Deleted images are left out. Needs a Full key. A key limited to one domain answers 403.

Lists are paged with cursors. Read `next_cursor` and send it as `after` for the next page. A page has 50 items unless you set `per_page`, up to 100.

## Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | string | No | Text to find in the file name, up to 200 characters. |
| `type` | string | No | `png`, `jpeg` or `gif`. |
| `direction` | string | No | `asc` or `desc`. Defaults to `desc`. |
| `per_page` | integer | No | How many items to return, from 1 to 100. Defaults to 50. |
| `after` | string | No | A `next_cursor` from the last page. Returns the items after it. |
| `before` | string | No | A `prev_cursor` from the last page. Returns the items before it. When you send both, `before` wins. |

## Response

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | No | The images on this page. |
| `data[].id` | string | No | The image id. |
| `data[].file_name` | string | No | The file name. |
| `data[].url` | string \| null | No | The hosted URL to use in an `img` tag. |
| `data[].content_type` | string | No | `image/png`, `image/jpeg` or `image/gif`. |
| `data[].size_bytes` | integer | No | The size in bytes. |
| `data[].width` | integer | No | The width in pixels. |
| `data[].height` | integer | No | The height in pixels. |
| `data[].creator_name` | string \| null | No | The team member who uploaded it. |
| `data[].created_at` | string | No | When it was added. |
| `prev_cursor` | string \| null | No | Send it as `before` to get the page before. `null` on the first page. |
| `next_cursor` | string \| null | No | Send it as `after` to get the next page. `null` on the last page. |
| `total` | integer | No | The exact number of images that match the filters, on all pages. |

## Request

cURL:

```bash
curl -X GET https://api.inboxjot.com/v1/images \
  -H "Authorization: Bearer $INBOXJOT_API_KEY"
```

## Responses

| Status | Description |
| --- | --- |
| 200 | Returns a page of images. |
| 400 | A parameter is missing or invalid. |
| 401 | The API key is missing, revoked or expired. |
| 403 | The key is a Sending key or is limited to one domain, or the request comes from outside its IP allowlist. |
| 429 | Too many requests for this key. Wait for the seconds in the Retry-After header. |
| 500 | Something failed on our side. Retry later. |

200:

```json
{
  "data": [
    {
      "id": "img_06d2mfk8r3wn5gt7kc2pb",
      "file_name": "hero.png",
      "url": "https://images.inboxjot-cdn.com/media/ws_06d2mfk8r1/i/3f9a2c1b7e4d6a05.png",
      "content_type": "image/png",
      "size_bytes": 412000,
      "width": 1200,
      "height": 630,
      "creator_name": null,
      "created_at": "2026-10-30T09:00:00.000Z"
    }
  ],
  "prev_cursor": null,
  "next_cursor": null,
  "total": 1
}
```

400:

```json
{
  "name": "validation_error",
  "status": 400,
  "message": "Invalid cursor",
  "errors": [
    {
      "message": "Invalid cursor",
      "location": "after"
    }
  ],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

401:

```json
{
  "name": "unauthorized",
  "status": 401,
  "message": "Unauthorized",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

403:

```json
{
  "name": "forbidden",
  "status": 403,
  "message": "This key cannot be used from 203.0.113.7",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

429:

```json
{
  "name": "rate_limit_exceeded",
  "status": 429,
  "message": "Too many attempts. Try again later.",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

500:

```json
{
  "name": "unknown_error",
  "status": 500,
  "message": "Something went wrong. Please try again later.",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```
