📖
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. 💡Best practices

Make specific JSON API request

PreviousPerform your first requestNextManage the static resources

Last updated 1 year ago

CtrlK
  • How to include the relationship on GET JSON API requests ?
  • How to filter on GET JSON API requests ?
  • How to sort on GET JSON API requests ?

How to include the relationship on GET JSON API requests ?

In order to avoid making several calls when only one can be enough, you can on each resources include adequate relationships.

For example if you want to retrieve a product with its tracks and label you can do :

https//api.idol.io/api/v2/products/1?include=tracks,label

How to filter on GET JSON API requests ?

As describe on each resource list endpoints you can filter on one or several attributes.

For example if you want to retrieve all the acrtive products from a specific label, you can do :

https//api.idol.io/api/v2/products?filter[label-id]=1&filter[active]=true

How to sort on GET JSON API requests ?

You can also ask specific sort on attribute resources.

For example if you want to retrieve your products sorting by name you can do :

https//api.idol.io/api/v2/products/1?sort=name