📖
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

Territory

PreviousTagNextTrack

Last updated 5 months ago

CtrlK
  • List Territories
  • Filter resources
  • Get Territory

List Territories

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

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

{
  "data": [
    {
      "id": "<ID>",
      "type": "territories",
      "links": {
        "self": "https://api.idol.io/api/v2/territories/<ID>"
      },
      "attributes": {
        "name": "Andorra"
      }
    },
    {
      "id": "<ID>",
      "type": "territories",
      "links": {
        "self": "https://api.idol.io/api/v2/territories/<ID>"
      },
      "attributes": {
        "name": "United Arab Emirates"
      }
    },
    {
      "id": "<ID>",
      "type": "territories",
      "links": {
        "self": "https://api.idol.io/api/v2/territories/<ID>"
      },
      "attributes": {
        "name": "Afghanistan"
      }
    }
  ],
  "meta": {
    "record-count": 238,
    "page-count": 80
  },
  "links": {
    "first": "https://api.idol.io/api/v2/territories?page%5Bnumber%5D=1&page%5Bsize%5D=3",
    "next": "https://api.idol.io/api/v2/territories?page%5Bnumber%5D=2&page%5Bsize%5D=3",
    "last": "https://api.idol.io/api/v2/territories?page%5Bnumber%5D=80&page%5Bsize%5D=3"
  }
}

Filter resources

/api/v2/territories?filter[code-alpha-2]=FR

Get Territory

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

Path Parameters

Name
Type
Description

id*

number

ID of the Territory

Headers

Name
Type
Description

Authorization*

string

Bearer <token>

Content-Type*

string

application/vnd.api+json

{
  "data": {
    "id": "<ID>",
    "type": "territories",
    "links": {
      "self": "https://api.idol.io/api/v2/territories/<ID>"
    },
    "attributes": {
      "name": "Andorra"
    }
  }
}