Label

List Labels

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

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": [
    {
      "id": "<ID>",
      "type": "labels",
      "links": {
        "self": "https://api.idol.io/api/v2/labels/<ID>"
      },
      "attributes": {
        "created-at": "2020-05-30T10:46:32.552+02:00",
        "updated-at": "2020-05-30T10:46:32.552+02:00",
        "name": "Another great label",
        "children-count": 0,
        "usage": {
          "download": true,
          "on_demand_stream": true,
          "non_interactive_stream": true,
          "copy_scan": true
        },
        "description": null,
        "logo": null
      },
      "relationships": {
        "company": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/company",
            "related": "https://api.idol.io/api/v2/labels/<ID>/company"
          },
          "data": {
            "type": "companies",
            "id": "<ID>"
          }
        },
        "products": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/products",
            "related": "https://api.idol.io/api/v2/labels/<ID>/products"
          }
        },
        "rights": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/rights",
            "related": "https://api.idol.io/api/v2/labels/<ID>/rights"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "labels",
      "links": {
        "self": "https://api.idol.io/api/v2/labels/<ID>"
      },
      "attributes": {
        "created-at": "2020-05-28T14:31:28.301+02:00",
        "updated-at": "2020-05-30T16:11:51.780+02:00",
        "name": "Api Doc Test",
        "children-count": 1,
        "usage": {
          "download": true,
          "on_demand_stream": true,
          "non_interactive_stream": true,
          "copy_scan": true
        },
        "description": null,
        "logo": null
      },
      "relationships": {
        "company": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/company",
            "related": "https://api.idol.io/api/v2/labels/<ID>/company"
          },
          "data": {
            "type": "companies",
            "id": "<ID>"
          }
        },
        "products": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/products",
            "related": "https://api.idol.io/api/v2/labels/<ID>/products"
          }
        },
        "rights": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/rights",
            "related": "https://api.idol.io/api/v2/labels/<ID>/rights"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "labels",
      "links": {
        "self": "https://api.idol.io/api/v2/labels/<ID>"
      },
      "attributes": {
        "created-at": "2022-05-29T12:29:31.318+02:00",
        "updated-at": "2022-05-30T16:42:34.147+02:00",
        "name": "Demo label",
        "children-count": 1,
        "usage": {
          "download": true,
          "on_demand_stream": true,
          "non_interactive_stream": true,
          "copy_scan": true
        },
        "description": null,
        "logo": null
      },
      "relationships": {
        "company": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/company",
            "related": "https://api.idol.io/api/v2/labels/<ID>/company"
          },
          "data": {
            "type": "companies",
            "id": "<ID>"
          }
        },
        "products": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/products",
            "related": "https://api.idol.io/api/v2/labels/<ID>/products"
          }
        },
        "rights": {
          "links": {
            "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/rights",
            "related": "https://api.idol.io/api/v2/labels/<ID>/rights"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 21,
    "page-count": 7
  },
  "links": {
    "first": "https://api.idol.io/api/v2/labels?page%5Bnumber%5D=1&page%5Bsize%5D=3",
    "next": "https://api.idol.io/api/v2/labels?page%5Bnumber%5D=2&page%5Bsize%5D=3",
    "last": "https://api.idol.io/api/v2/labels?page%5Bnumber%5D=7&page%5Bsize%5D=3"
  }
}

Filter resources

Distributor

api/v2/labels?filter[distributor-id]=true

Companies

api/v2/labels?filter[company-ids]=1,2

Products

api/v2/labels?filter[product-ids]=1,2

ProductGenres

api/v2/labels?filter[product-genre-ids]=1,2

Name

api/v2/labels?filter[name]=Company Test

Get Label

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

Path Parameters

Name	Type	Description
id*	number	ID of the Label

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": {
    "id": "<ID>",
    "type": "labels",
    "links": {
      "self": "https://api.idol.io/api/v2/labels/<ID>"
    },
    "attributes": {
      "created-at": "2022-05-30T10:46:32.552+02:00",
      "updated-at": "2022-05-30T10:46:32.552+02:00",
      "name": "Another great label",
      "children-count": 0,
      "usage": {
        "download": true,
        "on_demand_stream": true,
        "non_interactive_stream": true,
        "copy_scan": true
      },
      "description": null,
      "logo": null
    },
    "relationships": {
      "company": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/company",
          "related": "https://api.idol.io/api/v2/labels/<ID>/company"
        },
        "data": {
          "type": "companies",
          "id": "<ID>"
        }
      },
      "products": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/products",
          "related": "https://api.idol.io/api/v2/labels/<ID>/products"
        }
      },
      "rights": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/rights",
          "related": "https://api.idol.io/api/v2/labels/<ID>/rights"
        }
      }
    }
  }
}

Create Label

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

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
for_company*	object	Company object
rights	object	Rights object
name*	string	Label Test API
usage	object	{ "download": true, "on_demand_stream": true, "copy_scan": true, "non_interactive_stream": true }

200

{
  "data": {
    "id": "<ID>",
    "type": "labels",
    "links": {
      "self": "https://api.idol.io/api/v2/labels/<ID>"
    },
    "attributes": {
      "created-at": "2023-05-28T18:39:46.058+02:00",
      "updated-at": "2023-05-28T18:39:46.058+02:00",
      "name": "Label test API",
      "children-count": 0,
      "usage": {
        "download": true,
        "on_demand_stream": true,
        "non_interactive_stream": true,
        "copy_scan": true
      },
      "description": null,
      "logo": null
    },
    "relationships": {
      "company": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/company",
          "related": "https://api.idol.io/api/v2/labels/<ID>/company"
        },
        "data": {
          "type": "companies",
          "id": "<ID>"
        }
      },
      "products": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/products",
          "related": "https://api.idol.io/api/v2/labels/<ID>/products"
        }
      },
      "rights": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/rights",
          "related": "https://api.idol.io/api/v2/labels/<ID>/rights"
        }
      }
    }
  }
}

Update Label

PUT https://api.idol.io/api/v2/labels/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Label

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
rights	object	Rights object
name*	string	Label Test API
usage	object	{ "download": true, "on_demand_stream": true, "copy_scan": true, "non_interactive_stream": true }

200

{
  "data": {
    "id": "<ID>",
    "type": "labels",
    "links": {
      "self": "https://api.idol.io/api/v2/labels/<ID>"
    },
    "attributes": {
      "created-at": "2024-05-28T18:39:46.058+02:00",
      "updated-at": "2024-05-28T18:39:46.058+02:00",
      "name": "Label test API",
      "children-count": 0,
      "usage": {
        "download": true,
        "on_demand_stream": true,
        "non_interactive_stream": true,
        "copy_scan": true
      },
      "description": null,
      "logo": null
    },
    "relationships": {
      "company": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/company",
          "related": "https://api.idol.io/api/v2/labels/<ID>/company"
        },
        "data": {
          "type": "companies",
          "id": "<ID>"
        }
      },
      "products": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/products",
          "related": "https://api.idol.io/api/v2/labels/<ID>/products"
        }
      },
      "rights": {
        "links": {
          "self": "https://api.idol.io/api/v2/labels/<ID>/relationships/rights",
          "related": "https://api.idol.io/api/v2/labels/<ID>/rights"
        }
      }
    }
  }
}

Delete Label

DELETE https://api.idol.io/api/v2/labels/:id

Path Parameters

Name	Type	Description
id*	number	ID of the Label

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200