Skip to content
Documentation

List Images

GET
/api/v1/workspaces/{workspace_id}/images
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/images?per=10&page=1&sort=created_at_asc&archived=true' \
  --header 'Authorization: Bearer <token>'

Retrieves the images.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

search
string

Filter images by search term

sort
string
Allowed values: created_at_asc created_at_desc updated_at_asc updated_at_desc name_asc name_desc

Sorting

archived
string
default: false
Allowed values: true false all
Example
false

Filter images by archive status:

  • false (default): Only return non-archived images
  • true: Only return archived images
  • all: Return both archived and non-archived images

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
results
required
Array<object>
object
id
required
string
name
required
string
filename
required
string
width
required
integer
height
required
integer
file_size
required
integer
created_at
required
string format: date-time
updated_at
required
string format: date-time
organization_id
required
integer
public_url
required
string
description
required
string
nullable
extension
required
string
archived
required
boolean
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
      "name": "My Image",
      "filename": "image.png",
      "width": 100,
      "height": 100,
      "file_size": 1000,
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z",
      "organization_id": 12345,
      "public_url": "https://www.example.com/image.png",
      "description": "A beautiful image of a cat",
      "extension": "png",
      "archived": false
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}