collection

Get collection details

Returns full collection details in a JSON object.

get/collection/{collectionId}

Request

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

Path parameters

collectionIdnumber required
Example:537982

Query parameters

languagestring
Example:en

Response

Collection details

idnumber
namestring
overviewstring
posterPathstring
backdropPathstring

Example response

{
  "id": 123,
  "name": "A Movie Collection",
  "overview": "Overview of collection",
  "parts": [
    {
      "id": 1234,
      "popularity": 10,
      "overview": "Overview of the movie",
      "originalLanguage": "en",
      "title": "Movie Title",
      "originalTitle": "Original Movie Title",
      "mediaInfo": {
        "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.