6 Calendar

Qstick edited this page 2018-05-17 18:00:21 -04:00

Table of Contents

• GET
• Summary
• Parameters
• Example
• Returns JsonArray

Endpoint: "/calendar"

GET

Summary

Gets upcoming albums, if start/end are not supplied albums released today and tomorrow will be returned

Parameters

Required: None

Optional:

start (date)

end (date)

includeArtist - true or false - Default: false

Example

To get a list of all items appearing on the Lidarr calendar between July 26, 2017 and July 27, 2017, you could call:

http://lidarr.ip:port/api/v1/calendar?apikey=YourApiKey&start=2017-07-26&end=2017-07-27

Note that you need to replace 'lidarr.ip' and 'port' with the IP address of the machine running Lidarr and the port it's listening on, in addition to 'YourApiKey' being replaced with the API key of your Lidarr installation.

Returns JsonArray

[
  {
    "title": "truANT",
    "artistId": 2,
    "monitored": true,
    "path": "C:\\Test\\Alien Ant Farm\\truANT (2003)",
    "profileId": 2,
    "releaseDate": "2003-08-08T00:00:00Z",
    "artist": {
      "name": "Alien Ant Farm",
      "foreignArtistId": "8ac6cc32-8ddf-43b1-9ac4-4b04f9053176",
      "tadbId": 113859,
      "overview": "Alien Ant Farm is an American rock band that formed in Riverside, California, United States, in 1996. Their name comes from an idea original guitarist Terry Corso had about aliens and the Earth: \"it was just my daydream about our planet being seeded by entities from other dimensions.\"[1] They have released five studio albums, and have sold over 5 million units worldwide. The band is best known for their Michael Jackson cover \"Smooth Criminal.\"",
      "images": [],
      "members": [],
      "path": "C:\\Test\\Alien Ant Farm",
      "profileId": 2,
      "albumFolder": true,
      "monitored": true,
      "genres": [
        "alternative metal",
        "alternative rock",
        "funk metal",
        "industrial metal",
        "nu metal",
        "pop punk",
        "pop rock",
        "post-grunge",
        "rap metal",
        "rap rock",
        "rock"
      ],
      "cleanName": "alienantfarm",
      "tags": [],
      "added": "2017-07-08T05:27:16.5290674Z",
      "addOptions": {
        "searchForMissingTracks": false,
        "ignoreTracksWithFiles": true,
        "ignoreTracksWithoutFiles": false,
        "monitored": false
      },
      "nameSlug": "alienantfarm",
      "id": 2
    },
    "images": [],
    "statistics": {
      "trackFileCount": 0,
      "trackCount": 12,
      "totalTrackCount": 0,
      "sizeOnDisk": 0,
      "percentOfTracks": 0.0
    },
    "id": 4
  }
]