Skip to content

Get Image

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

Retrieves an image.

workspace_id
required
integer

Workspace ID

id
required
string

Image ID

Successful

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
archived
required
boolean

Unauthorized

object
message
required
string
Example
Record not found

Forbidden

object
message
required
string
Example
Record not found

Not Found

object
message
required
string
Example
Record not found