Skip to content
Documentation

List Images

GET
/api/v1/workspaces/{workspace_id}/images

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

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