Availabilities

Endpointhttps://api.idol.io/api/v2

Manage availability information for artists, products, and tracks on Digital Service Providers (DSPs).

Availabilities track the presence and external identifiers of your content on various streaming platforms, including:

External identifiers (e.g., Spotify IDs, Apple Music IDs)
Platform-specific URLs
Territory-specific availability

Supported item types: Artist, Product, Track

Use this resource to link your internal content to external platform identifiers for tracking and integration purposes.

List availabilities

GET

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

/availabilities

Retrieve a list of availabilities for artists, products, or tracks on DSPs

List availabilities › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[track-id]

string

Filter by track ID

filter[product-id]

string

Filter by product ID

filter[artist-id]

string

Filter by artist ID

List availabilities › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create an availability

POST

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

/availabilities

Create a new availability record linking an item (artist/product/track) to a DSP.

Required relationships: dsp, item

Required attributes: external

Create an availability › Request Body

object

Create an availability › Responses

Availability created successfully

object

object[]

Related resources included in the response

object

POST/availabilities

curl --request POST \
  --url https://api.idol.io/api/v2/availabilities \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "availabilities",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "dsps",
          "id": "1"
        }
      },
      "item": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "availabilities",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "dsps",
          "id": "1"
        }
      },
      "item": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get availability details

GET

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

/availabilities/{id}

Retrieve a single availability by ID

Get availability details › path Parameters

id

string · required

Resource ID

Get availability details › query Parameters

include

string

Comma-separated list of related resources to include

Get availability details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update an availability

PUT

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

/availabilities/{id}

Update an existing availability record

Update an availability › path Parameters

id

string · required

Resource ID

Update an availability › Request Body

object

Update an availability › Responses

Availability updated successfully

object

object[]

Related resources included in the response

object

PUT/availabilities/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/availabilities/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "availabilities",
    "id": "id",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp",
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "territory": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "item": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "availabilities",
    "id": "id",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp",
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "territory": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "item": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete an availability

DELETE

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

/availabilities/{id}

Delete an availability record

Delete an availability › path Parameters

id

string · required

Resource ID

Delete an availability › Responses

Availability deleted successfully

No data returned

Rights DSPs

Labelcamp API v2

Availabilities

Endpointhttps://api.idol.io/api/v2

Manage availability information for artists, products, and tracks on Digital Service Providers (DSPs).

Availabilities track the presence and external identifiers of your content on various streaming platforms, including:

External identifiers (e.g., Spotify IDs, Apple Music IDs)
Platform-specific URLs
Territory-specific availability

Supported item types: Artist, Product, Track

Use this resource to link your internal content to external platform identifiers for tracking and integration purposes.

List availabilities

GET

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

/availabilities

Retrieve a list of availabilities for artists, products, or tracks on DSPs

List availabilities › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

filter[track-id]

string

Filter by track ID

filter[product-id]

string

Filter by product ID

filter[artist-id]

string

Filter by artist ID

List availabilities › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create an availability

POST

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

/availabilities

Create a new availability record linking an item (artist/product/track) to a DSP.

Required relationships: dsp, item

Required attributes: external

Create an availability › Request Body

object

Create an availability › Responses

Availability created successfully

object

object[]

Related resources included in the response

object

POST/availabilities

curl --request POST \
  --url https://api.idol.io/api/v2/availabilities \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "availabilities",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "dsps",
          "id": "1"
        }
      },
      "item": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "availabilities",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "dsps",
          "id": "1"
        }
      },
      "item": {
        "data": {
          "type": "tracks",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get availability details

GET

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

/availabilities/{id}

Retrieve a single availability by ID

Get availability details › path Parameters

id

string · required

Resource ID

Get availability details › query Parameters

include

string

Comma-separated list of related resources to include

Get availability details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update an availability

PUT

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

/availabilities/{id}

Update an existing availability record

Update an availability › path Parameters

id

string · required

Resource ID

Update an availability › Request Body

object

Update an availability › Responses

Availability updated successfully

object

object[]

Related resources included in the response

object

PUT/availabilities/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/availabilities/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "availabilities",
    "id": "id",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp",
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "territory": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "item": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "availabilities",
    "id": "id",
    "attributes": {
      "external": "spotify:track:3n3Ppam7vgaVa1iaRUc9Lp",
      "url": "https://open.spotify.com/track/3n3Ppam7vgaVa1iaRUc9Lp",
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "dsp": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "territory": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "item": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete an availability

DELETE

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

/availabilities/{id}

Delete an availability record

Delete an availability › path Parameters

id

string · required

Resource ID

Delete an availability › Responses

Availability deleted successfully

No data returned

Rights DSPs