get /rest/api/medias
Retrieves the collection of Media resources.
Returns a paginated collection of media in the current organization.
| Name | Type | Required | Description |
|---|
X-Flowkiwi-Organization-Id | string | required | The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance. |
Query parameters
| Name | Type | Required | Description |
|---|
page | integer | - | The collection page number |
itemsPerPage | integer | - | The number of items per page |
id | string | - | |
id[] | string[] | - | |
type | string | - | |
type[] | string[] | - | |
Response
200 - Media collection
Content-Type: application/ld+json
| Property | Type | Required | Description |
|---|
hydra:totalItems | integer | - | |
hydra:search | object | - | |
Show hydra:search fields| Property | Type | Required | Description |
|---|
@type | string | - | | hydra:template | string | - | | hydra:variableRepresentation | string | - | | hydra:mapping | object[] | - | | Show hydra:mapping fields| Property | Type | Required | Description |
|---|
@type | string | - | | variable | string | - | | property | string | null | - | | required | boolean | - | |
|
|
hydra:view | object | - | |
Show hydra:view fields| Property | Type | Required | Description |
|---|
@id | string | - | | @type | string | - | | hydra:first | string | - | | hydra:last | string | - | | hydra:previous | string | - | | hydra:next | string | - | |
|
hydra:member | Media[] | required | |
Show hydra:member fields| Property | Type | Required | Description |
|---|
@context | object | - | | @id | string | required | | @type | string | required | | id | string | - | The resource's unique identifier (UUID). | contentUrl | string | null | - | The URL to fetch the uploaded file. | mimeType | string | null | - | MIME type of the file | type | "image" | "video" | "file" | - | Media type based on MIME type (image, video, or file) | hash | string | null | - | SHA256 hash of the file | dimensions | EmbeddedImageDimensionResource | null | - | | Show dimensions fields| Property | Type | Required | Description |
|---|
width | integer | required | Image width in pixels | height | integer | required | Image height in pixels |
| createdAt | string | null | - | | updatedAt | string | null | - | |
|
Errors
403 - Access denied. The caller is missing one or more identity permissions required for this operation.
Content-Type: application/problem+json
| Property | Type | Required | Description |
|---|
@context | object | - | |
@id | string | required | |
@type | string | required | |
type | string | - | |
title | string | - | |
status | integer | - | |
detail | string | - | |
missingPermissions | string[] | - | Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission. |