📖
API documentation
  • 🚀 Dashboard
  • 📅Changelog
  • 💾Deprecations
  • 🛠️Resources
    • Artist
    • ArtistRole
    • AppleArtist
    • AssetAttachment
    • Availability
    • Booklet
    • Company
    • Continent
    • Currency
    • Customisation
    • Distributor
    • DistributorPriceCode
    • DistributorProductSubgenres
    • Dsp
    • DspState
    • DspTag
    • DspUploadIdentification
    • Gender
    • ImportTask
    • ImportTask [NEW]
    • Label
    • Language
    • Offer
    • Playlist
    • Product
    • ProductGenre
    • ProductType
    • Quotas
    • Record
    • Retail
    • Role
    • Right
    • SendTask
    • SendTaskFactory
    • SpotifyArtist
    • Tag
    • Territory
    • Track
    • TrackOffer
    • TrackVideo
    • Video
    • Webhooks
  • 💡Best practices
    • JSON API documentation
    • Perform your first request
    • Make specific JSON API request
    • Manage the static resources
    • List of common HTTP status codes
    • ⁉️Timeouts and Errors
  • 🖥️Tutorials
    • Full Scenario
    • Managing artists
    • Upload a Dolby Atmos
    • Set a timed release
    • Update Scenario
  • 🔗Exports
    • Daily Trends export
  • 📡Webhooks
    • Presentation
Powered by GitBook
On this page
  1. 🛠️Resources

Distributor

PreviousCustomisationNextDistributorPriceCode

Last updated 5 months ago

CtrlK
  • List Distributors
  • Filter resources
  • Get Distributor

List Distributors

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

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

{
  "data": [
    {
      "id": "<ID>",
      "type": "distributors",
      "links": {
        "self": "https://api.idol.io/api/v2/distributors/<ID>"
      },
      "attributes": {
        "created-at": "2021-11-18T08:07:12.000+01:00",
        "updated-at": "2023-05-28T14:33:33.158+02:00",
        "name": "Sound Distro",
        "is-strict": true,
        "children-count": 10
      },
      "relationships": {
        "companies": {
          "links": {
            "self": "https://api.idol.io/api/v2/distributors/<ID>/relationships/companies",
            "related": "https://api.idol.io/api/v2/distributors/<ID>/companies"
          }
        },
        "rights": {
          "links": {
            "self": "https://api.idol.io/api/v2/distributors/<ID>/relationships/rights",
            "related": "https://api.idol.io/api/v2/distributors/<ID>/rights"
          }
        },
        "currency": {
          "links": {
            "self": "https://api.idol.io/api/v2/distributors/<ID>/relationships/currency",
            "related": "https://api.idol.io/api/v2/distributors/<ID>/currency"
          },
          "data": {
            "type": "currencies",
            "id": "<ID>"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 1,
    "page-count": 1
  },
  "links": {
    "first": "https://api.idol.io/api/v2/distributors?page%5Bnumber%5D=1&page%5Bsize%5D=20",
    "last": "https://api.idol.io/api/v2/distributors?page%5Bnumber%5D=1&page%5Bsize%5D=20"
  }
}

Filter resources

api/v2/distributors?filter[name]=IDOL

Get Distributor

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

Path Parameters

Name
Type
Description

id*

number

ID of the Distributor

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

{
  "data": {
    "id": "<ID>",
    "type": "distributors",
    "links": {
      "self": "https://api.idol.io/api/v2/distributors/<ID>"
    },
    "attributes": {
      "created-at": "2021-11-18T08:07:12.000+01:00",
      "updated-at": "2023-05-28T14:33:33.158+02:00",
      "name": "Sound Distro",
      "is-strict": true,
      "children-count": 10
    },
    "relationships": {
      "companies": {
        "links": {
          "self": "https://api.idol.io/api/v2/distributors/<ID>/relationships/companies",
          "related": "https://api.idol.io/api/v2/distributors/<ID>/companies"
        }
      },
      "rights": {
        "links": {
          "self": "https://api.idol.io/api/v2/distributors/<ID>/relationships/rights",
          "related": "https://api.idol.io/api/v2/distributors/<ID>/rights"
        }
      },
      "currency": {
        "links": {
          "self": "https://api.idol.io/api/v2/distributors/<ID>/relationships/currency",
          "related": "https://api.idol.io/api/v2/distributors/<ID>/currency"
        },
        "data": {
          "type": "currencies",
          "id": "<ID>"
        }
      }
    }
  }
}