get /api/medias
Retrieves the collection of Media resources.
Returns a paginated collection of media in the current organization.
Query parameters
| Name | Type | Required | Description |
|---|
page | integer | - | The collection page number |
itemsPerPage | integer | - | The number of items per page |
properties[] | string[] | - | Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty} |
id[] | string[] | - | Only the items with one of these ids, each a UUID or the item IRI. |
type | string | - | Media type |
type[] | string[] | - | Media type |
Response
200 - Media collection
Content-Type: application/ld+json
| Property | Type | Required | Description |
|---|
search | object | - | |
Show search fields| Property | Type | Required | Description |
|---|
@type | string | - | | mapping | object[] | - | | Show mapping fields| Property | Type | Required | Description |
|---|
@type | string | - | | property | string | null | - | | required | boolean | - | | variable | string | - | |
| template | string | - | | variableRepresentation | string | - | |
|
totalItems | integer | - | |
view | object | - | |
Show view fields| Property | Type | Required | Description |
|---|
@id | string | - | | @type | string | - | | first | string | null | - | | last | string | null | - | | next | string | null | - | | previous | string | null | - | |
|
member | Media[] | required | |
Show member fields| Property | Type | Required | Description |
|---|
@context | string | object | - | | @id | string | required | | @type | string | required | | contentUrl | string | null | - | The URL to fetch the uploaded file. | createdAt | string | null | - | | dimensions | EmbeddedImageDimensionResource | null | - | Image dimensions (width and height in pixels). Only present for image files. | Show dimensions fields| Property | Type | Required | Description |
|---|
height | integer | required | Image height in pixels | width | integer | required | Image width in pixels |
| hash | string | null | - | SHA256 hash of the file | id | string | - | The resource's unique identifier (UUID). | mimeType | string | null | - | MIME type of the file | type | "image" | "video" | "file" | - | Media type based on MIME type (image, video, or file) | updatedAt | string | null | - | |
|
Errors
403 - Access denied. The caller is missing one or more permissions required for this operation.
Content-Type: application/problem+json
| Property | Type | Required | Description |
|---|
@context | string | object | - | |
@id | string | required | |
@type | string | required | |
detail | string | - | |
missingPermissions | string[] | - | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
status | integer | - | |
title | string | - | |
type | string | - | |