v1

latestOpenAPI 3.0.02026-07-14416.5 KB

List and search media items

Retrieve information about multiple media items with the ability to search and paginate.

get/

Query parameters

order'ascending' | 'descending'

Example:ascending

The order of search results.

page_indexinteger

Example:1

Which page to retrieve in pagination

page_sizeinteger

Example:50

How many items at most per page

start_timestring

Example:2020-01-01T14:00:00.000Z

Retrieve results created on or after this timestap.

end_timestring

Example:2020-01-01T14:00:00.000Z

Retrieve results created on or before this timestamp.

Response

Successfully retrieved

countinteger

The total number of records returned by your request.

page_indexinteger

The page_index used in your request.

page_sizeinteger

The amount of records returned in this response.

Example response

{
  "_embedded": {
    "media": [
      {
        "account_id": "abcd1234",
        "etag": "aaaaaaaabbbbccccdddd0123456789ab",
        "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
        "media_size": 1234567,
        "mime_type": "audio/vnd.wave",
        "original_file_name": "test.wav",
        "store_id": "s3",
        "time_created": "2020-01-01T14:00:00.000Z",
        "time_last_updated": "2020-01-01T14:00:00.000Z",
        "times_downloaded": 1
      }
    ]
  },
  "_links": {
    "first": {
      "href": "/v3/media?page_size=20&account_id=abcd1234&order=descending"
    },
    "last": {
      "href": "/v3/media?page_size=20&account_id=abcd1234&order=descending"
    },
    "self": {
      "href": "/v3/media?page_size=20&account_id=abcd1234&order=descending"
    }
  },
  "count": 1,
  "page_size": 20
}

All 4 operations