Labelcamp API v2

DSP Upload Identifications

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

Digital Service Provider upload configuration details.

Additional track options are available for these DSPs:

Amazon
Anghami
Beatport
Deezer
Facebook
Facebook Fingerprint
Facebook Library
Juno Download
Kkbox
Napster
Pandora
Playzer
Soundcloud
Spotify
Tidal
Tiktok
Youtube Art Track
Youtube Content ID

List DSP upload identifications

GET

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

/dsp-upload-identifications

Retrieve a list of DSP upload identifications with optional filtering by distributor, DSP, or status.

List DSP upload identifications › query Parameters

filter[distributor-id]

string

Filter by distributor ID

filter[dsp-id]

string

Filter by DSP ID

filter[status]

string · enum

Filter by status

Enum values:

standby

active

closed

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

List DSP upload identifications › Responses

List of DSP upload identifications

object[]

object

GET/dsp-upload-identifications

curl --request GET \
  --url https://api.idol.io/api/v2/dsp-upload-identifications

shell

Example Responses

{
  "data": [
    {
      "type": "dsp-upload-identifications",
      "id": "1",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "dsp-name": "Apple",
        "options": [
          {
            "name": "custom_vendor_id",
            "label": "Custom Vendor ID",
            "hint": "If you have trouble uploading/updating an album uploaded via another distributor or the Apple Producer, you can fill this field. You will find it directly on your Apple Producer",
            "format": null,
            "type": "string",
            "value": null
          },
          {
            "name": "preorder_only",
            "label": "Number of Last Tracks as Preorder",
            "hint": "You can specify up to 50% of the album tracks (or videos) as Instant-Gratification tracks. Purchasers who pre-order the album can download the tracks immediately",
            "format": null,
            "type": "integer",
            "value": null
          },
          {
            "name": "itunes_preorder_price_code_id",
            "label": "Price Code During Preorder Period",
            "hint": null,
            "format": null,
            "type": "integer",
            "value": [
              {
                "value": 1,
                "name": "P1 - 0,99€"
              },
              {
                "value": 2,
                "name": "P2 - 1,99€"
              },
              {
                "value": 3,
                "name": "P3 - 2,99€"
              }
            ]
          }
        ],
        "track-options": {}
      },
      "relationships": {
        "offers": {
          "data": []
        },
        "dsp": {
          "data": {
            "type": "dsps",
            "id": "1"
          }
        }
      }
    },
    {
      "type": "dsp-upload-identifications",
      "id": "2",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "dsp-name": "Amazon",
        "options": {},
        "track-options": {}
      },
      "relationships": {
        "offers": {
          "data": []
        },
        "dsp": {
          "data": {
            "type": "dsps",
            "id": "2"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 1,
      "count": 2
    }
  }
}

json

application/vnd.api+json

Get a specific DSP upload identification

GET

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

/dsp-upload-identifications/{id}

Retrieve a single DSP upload identification by its ID.

Get a specific DSP upload identification › path Parameters

id

string · required

The DSP upload identification ID

Get a specific DSP upload identification › Responses

A single DSP upload identification

object

GET/dsp-upload-identifications/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/dsp-upload-identifications/:id

shell

Example Responses

{
  "data": {
    "type": "dsp-upload-identifications",
    "id": "1",
    "attributes": {
      "created-at": "2023-01-15T10:00:00Z",
      "updated-at": "2023-01-15T10:00:00Z",
      "dsp-name": "Apple",
      "options": [
        {
          "name": "custom_vendor_id",
          "label": "Custom Vendor ID",
          "hint": "If you have trouble uploading/updating an album uploaded via another distributor or the Apple Producer, you can fill this field. You will find it directly on your Apple Producer",
          "format": null,
          "type": "string",
          "value": null
        },
        {
          "name": "preorder_only",
          "label": "Number of Last Tracks as Preorder",
          "hint": "You can specify up to 50% of the album tracks (or videos) as Instant-Gratification tracks. Purchasers who pre-order the album can download the tracks immediately",
          "format": null,
          "type": "integer",
          "value": null
        },
        {
          "name": "itunes_preorder_price_code_id",
          "label": "Price Code During Preorder Period",
          "hint": null,
          "format": null,
          "type": "integer",
          "value": [
            {
              "value": 1,
              "name": "P1 - 0,99€"
            },
            {
              "value": 2,
              "name": "P2 - 1,99€"
            },
            {
              "value": 3,
              "name": "P3 - 2,99€"
            }
          ]
        }
      ],
      "track-options": {
        "monetization": true
      }
    },
    "relationships": {
      "offers": {
        "data": [
          {
            "type": "offers",
            "id": "123"
          }
        ]
      },
      "dsp": {
        "data": {
          "type": "dsps",
          "id": "3"
        }
      }
    }
  }
}

json

application/vnd.api+json

DSPs DSP States

Labelcamp API v2

DSP Upload Identifications

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

Digital Service Provider upload configuration details.

Additional track options are available for these DSPs:

Amazon
Anghami
Beatport
Deezer
Facebook
Facebook Fingerprint
Facebook Library
Juno Download
Kkbox
Napster
Pandora
Playzer
Soundcloud
Spotify
Tidal
Tiktok
Youtube Art Track
Youtube Content ID

List DSP upload identifications

GET

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

/dsp-upload-identifications

Retrieve a list of DSP upload identifications with optional filtering by distributor, DSP, or status.

List DSP upload identifications › query Parameters

filter[distributor-id]

string

Filter by distributor ID

filter[dsp-id]

string

Filter by DSP ID

filter[status]

string · enum

Filter by status

Enum values:

standby

active

closed

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

List DSP upload identifications › Responses

List of DSP upload identifications

object[]

object

GET/dsp-upload-identifications

curl --request GET \
  --url https://api.idol.io/api/v2/dsp-upload-identifications

shell

Example Responses

{
  "data": [
    {
      "type": "dsp-upload-identifications",
      "id": "1",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "dsp-name": "Apple",
        "options": [
          {
            "name": "custom_vendor_id",
            "label": "Custom Vendor ID",
            "hint": "If you have trouble uploading/updating an album uploaded via another distributor or the Apple Producer, you can fill this field. You will find it directly on your Apple Producer",
            "format": null,
            "type": "string",
            "value": null
          },
          {
            "name": "preorder_only",
            "label": "Number of Last Tracks as Preorder",
            "hint": "You can specify up to 50% of the album tracks (or videos) as Instant-Gratification tracks. Purchasers who pre-order the album can download the tracks immediately",
            "format": null,
            "type": "integer",
            "value": null
          },
          {
            "name": "itunes_preorder_price_code_id",
            "label": "Price Code During Preorder Period",
            "hint": null,
            "format": null,
            "type": "integer",
            "value": [
              {
                "value": 1,
                "name": "P1 - 0,99€"
              },
              {
                "value": 2,
                "name": "P2 - 1,99€"
              },
              {
                "value": 3,
                "name": "P3 - 2,99€"
              }
            ]
          }
        ],
        "track-options": {}
      },
      "relationships": {
        "offers": {
          "data": []
        },
        "dsp": {
          "data": {
            "type": "dsps",
            "id": "1"
          }
        }
      }
    },
    {
      "type": "dsp-upload-identifications",
      "id": "2",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "dsp-name": "Amazon",
        "options": {},
        "track-options": {}
      },
      "relationships": {
        "offers": {
          "data": []
        },
        "dsp": {
          "data": {
            "type": "dsps",
            "id": "2"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 1,
      "count": 2
    }
  }
}

json

application/vnd.api+json

Get a specific DSP upload identification

GET

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

/dsp-upload-identifications/{id}

Retrieve a single DSP upload identification by its ID.

Get a specific DSP upload identification › path Parameters

id

string · required

The DSP upload identification ID

Get a specific DSP upload identification › Responses

A single DSP upload identification

object

GET/dsp-upload-identifications/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/dsp-upload-identifications/:id

shell

Example Responses

{
  "data": {
    "type": "dsp-upload-identifications",
    "id": "1",
    "attributes": {
      "created-at": "2023-01-15T10:00:00Z",
      "updated-at": "2023-01-15T10:00:00Z",
      "dsp-name": "Apple",
      "options": [
        {
          "name": "custom_vendor_id",
          "label": "Custom Vendor ID",
          "hint": "If you have trouble uploading/updating an album uploaded via another distributor or the Apple Producer, you can fill this field. You will find it directly on your Apple Producer",
          "format": null,
          "type": "string",
          "value": null
        },
        {
          "name": "preorder_only",
          "label": "Number of Last Tracks as Preorder",
          "hint": "You can specify up to 50% of the album tracks (or videos) as Instant-Gratification tracks. Purchasers who pre-order the album can download the tracks immediately",
          "format": null,
          "type": "integer",
          "value": null
        },
        {
          "name": "itunes_preorder_price_code_id",
          "label": "Price Code During Preorder Period",
          "hint": null,
          "format": null,
          "type": "integer",
          "value": [
            {
              "value": 1,
              "name": "P1 - 0,99€"
            },
            {
              "value": 2,
              "name": "P2 - 1,99€"
            },
            {
              "value": 3,
              "name": "P3 - 2,99€"
            }
          ]
        }
      ],
      "track-options": {
        "monetization": true
      }
    },
    "relationships": {
      "offers": {
        "data": [
          {
            "type": "offers",
            "id": "123"
          }
        ]
      },
      "dsp": {
        "data": {
          "type": "dsps",
          "id": "3"
        }
      }
    }
  }
}

json

application/vnd.api+json

DSPs DSP States