Availability

List Availabilities

GET https://api.idol.io/api/v2/availabilities

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": [
    {
        "id": "<ID>",
        "type": "availabilities",
        "links": {
            "self": "https://api.idol.io/api/v2/availabilities/<ID>"
        },
        "attributes": {
            "created-at": "2009-03-23T13:17:37.000+01:00",
            "updated-at": "2011-04-29T17:21:32.000+02:00",
            "external": "32332",
            "url": "https://open.spotify.com/album/0n4P6BsuT61HgsKExU0",
            "name": "WW"
        },
        "relationships": {
            "dsp": {
                "links": {
                    "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/dsp",
                    "related": "https://api.idol.io/api/v2/availabilities/<ID>/dsp"
                },
                "data": {
                    "type": "dsps",
                    "id": "<ID>"
                }
            },
            "territory": {
                "links": {
                    "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/territory",
                    "related": "https://api.idol.io/api/v2/availabilities/<ID>/territory"
                },
                "data": null
            },
            "item": {
                "links": {
                    "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/item",
                    "related": "https://api.idol.io/api/v2/availabilities/<ID>/item"
                },
                "data": {
                    "type": "products",
                    "id": "<ID>"
                }
            }
        }
    },
    {
        "id": "<ID>",
        "type": "availabilities",
        "links": {
            "self": "https://api.idol.io/api/v2/availabilities/<ID>"
        },
        "attributes": {
            "created-at": "2009-03-23T13:17:37.000+01:00",
            "updated-at": "2011-04-29T17:21:33.000+02:00",
            "external": "543",
            "url": "https://open.spotify.com/album/0n4P6BsuT61ggsKExU0",
            "name": "WW"
        },
        "relationships": {
            "dsp": {
                "links": {
                    "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/dsp",
                    "related": "https://api.idol.io/api/v2/availabilities/<ID>/dsp"
                },
                "data": {
                    "type": "dsps",
                    "id": "<ID>"
                }
            },
            "territory": {
                "links": {
                    "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/territory",
                    "related": "https://api.idol.io/api/v2/availabilities/<ID>/territory"
                },
                "data": null
            },
            "item": {
                "links": {
                    "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/item",
                    "related": "https://api.idol.io/api/v2/availabilities/<ID>/item"
                },
                "data": {
                    "type": "products",
                    "id": "<ID>"
                }
            }
        }
    }
  }
],
"meta": {
    "record-count": 239746,
    "page-count": 1301
},
"links": {
    "first": "https://api.idol.io/api/v2/availabilities?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "next": "https://api.idol.io/api/v2/availabilities?page%5Bnumber%5D=2&page%5Bsize%5D=20",
    "last": "https://api.idol.io/api/v2/availabilities?page%5Bnumber%5D=1301939&page%5Bsize%5D=20"
}
}

Filter resources

Track

api/v2/availabilities?filter[track-id]=1

Product

Artist

Get Availability

GET https://api.idol.io/api/v2/availabilities/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Availability

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": {
    "id": "<ID>",
    "type": "availabilities",
    "links": {
      "self": "https://api.idol.io/api/v2/availabilities/<ID>"
    },
    "attributes": {
      "created-at": "2023-03-23T13:17:37.000+01:00",
      "updated-at": "2023-04-29T17:21:32.000+02:00",
      "external": "spotify:artist:7AyZmXpGePqwdreG0wqdj5",
      "url": "https://open.spotify.com/album/0n4P6BsuT61HgsKExU0",
      "name": "WW"
    },
    "relationships": {
      "dsp": {
        "links": {
          "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/dsp",
          "related": "https://api.idol.io/api/v2/availabilities/<ID>/dsp"
        },
        "data": {
          "type": "dsps",
          "id": "<ID>"
        }
      },
      "territory": {
        "links": {
          "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/territory",
          "related": "https://api.idol.io/api/v2/availabilities/<ID>/territory"
        },
        "data": null
      },
      "item": {
        "links": {
          "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/item",
          "related": "https://api.idol.io/api/v2/availabilities/<ID>/item"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      }
    }
  }
}

Create Availability

POST https://api.idol.io/api/v2/availabilities

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
dsp*	object	Language object
territory	object	Group object
item*	object	Item object (Artist / Product / Track)
external*	string	f017cc3486d70412bba..

200 Create an artist availability

{
    "data": {
      "attributes": {
        "external": "spotify:artist:4XGbuIJBheaKE2UGZ33am9"
      },
      "relationships": {
        "dsp": {
          "data": {
            "type": "dsps",
            "id": "30"
          }
        },
        "item": {
          "data": {
            "type": "artists",
            "id": "3163837"
          }
        }
      },
      "type": "availabilities"
    }
  }

Update Availability

PUT https://api.idol.io/api/v2/availabilities

Path Parameters

Name	Type	Description
id*	string	ID of the Availability

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
dsp*	object	Language object
territory	object	Group object
item*	object	Item object (Artist / Product / Track)
external*	string	f017cc3486d70412bba..

200

{
  "data": {
    "id": "<ID>",
    "type": "availabilities",
    "links": {
      "self": "https://api.idol.io/api/v2/availabilities/<ID>"
    },
    "attributes": {
      "created-at": "2023-08-10T12:21:00.714+02:00",
      "updated-at": "2023-08-10T12:21:00.714+02:00",
      "external": "qsd2382zazda94280mk",
      "url": null,
      "name": "DE"
    },
    "relationships": {
      "dsp": {
        "links": {
          "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/dsp",
          "related": "https://api.idol.io/api/v2/availabilities/<ID>/dsp"
        },
        "data": {
          "type": "dsps",
          "id": "<ID>"
        }
      },
      "territory": {
        "links": {
          "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/territory",
          "related": "https://api.idol.io/api/v2/availabilities/<ID>/territory"
        },
        "data": {
          "type": "territories",
          "id": "<ID>"
        }
      },
      "item": {
        "links": {
          "self": "https://api.idol.io/api/v2/availabilities/<ID>/relationships/item",
          "related": "https://api.idol.io/api/v2/availabilities/<ID>/item"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      }
    }
  }
}

Delete Group

DELETE https://api.idol.io/api/v2/availabilities/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Availability

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200