media

Get media

Returns all media (can be filtered and limited) in a JSON object.

get/media

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/media
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Query parameters

takenumber nullable
Example:20
skipnumber nullable
filter'all' | 'available' | 'partial' | 'allavailable' | 'processing' | 'pending' | 'deleted' nullable
sort'added' | 'modified' | 'mediaAdded'

Response

Returned media

Example response

{
  "pageInfo": {
    "page": 1,
    "pages": 10,
    "results": 100
  },
  "results": [
    {
      "requests": [
        {
          "id": 123,
          "createdAt": "2020-09-12T10:00:27.000Z",
          "updatedAt": "2020-09-12T10:00:27.000Z",
          "requestedBy": {
            "id": 1,
            "email": "hey@itsme.com",
            "userType": 1,
            "createdAt": "2020-09-02T05:02:23.000Z",
            "updatedAt": "2020-09-02T05:02:23.000Z",
            "requestCount": 5
          },
          "modifiedBy": {
            "id": 1,
            "email": "hey@itsme.com",
            "userType": 1,
            "createdAt": "2020-09-02T05:02:23.000Z",
            "updatedAt": "2020-09-02T05:02:23.000Z",
            "requestCount": 5
          }
        }
      ],
      "createdAt": "2020-09-12T10:00:27.000Z",
      "updatedAt": "2020-09-12T10:00:27.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 21 revisions of this API.