Labels

Label management and configuration

List labels

GET

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

/labels

Retrieve a list of labels with optional filtering.

List labels › query Parameters

filter[distributor-id]

string

Filter by distributor ID

filter[company-id]

string

Filter by company ID

filter[product-id]

string

Filter by product ID

filter[product-genre-id]

string

Filter by product genre ID

filter[name]

string

Filter by label name

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 labels › Responses

List of labels

LabelResource[]

PaginationMeta

GET/labels

curl https://api.idol.io/api/v2/labels \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "labels",
      "id": "1",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "name": "Another great label",
        "children-count": 0,
        "usage": {
          "download": true,
          "on-demand-stream": true,
          "non-interactive-stream": true,
          "copy-scan": true
        },
        "description": "An independent music label",
        "logo": "https://example.com/logos/label.png"
      },
      "relationships": {
        "company": {
          "data": {
            "type": "companies",
            "id": "123"
          }
        },
        "products": {
          "data": []
        },
        "rights": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 1,
      "count": 1
    }
  }
}

json

application/vnd.api+json

Create a label

POST

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

/labels

Create a new label associated with a company.

Create a label › Request Body

LabelCreateRequest

LabelResource · required

Create a label › Responses

Label created successfully

LabelResource

POST/labels

curl https://api.idol.io/api/v2/labels \
  --request POST \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "labels",
    "attributes": {
      "name": "My New Label",
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      }
    },
    "relationships": {
      "for-company": {
        "data": {
          "type": "companies",
          "id": "123"
        }
      }
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "labels",
    "attributes": {
      "name": "My New Label",
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      }
    },
    "relationships": {
      "for-company": {
        "data": {
          "type": "companies",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "required": {},
    "type": "labels",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "name": "Another great label",
      "children-count": 0,
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "description": "description",
      "logo": "logo"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "products": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

application/vnd.api+json

Get a specific label

GET

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

/labels/{id}

Retrieve a single label by its ID.

Get a specific label › path Parameters

id

string · required

The label ID

Get a specific label › Responses

A single label

LabelResource

Update a label

PUT

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

/labels/{id}

Update an existing label's attributes.

Update a label › path Parameters

id

string · required

The label ID

Update a label › Request Body

LabelUpdateRequest

LabelResource · required

Update a label › Responses

Label updated successfully

LabelResource

PUT/labels/{id}

curl https://api.idol.io/api/v2/labels/:id \
  --request PUT \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "labels",
    "id": "1",
    "attributes": {
      "name": "Updated Label Name",
      "usage": {
        "download": true,
        "on-demand-stream": false
      }
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "labels",
    "id": "1",
    "attributes": {
      "name": "Updated Label Name",
      "usage": {
        "download": true,
        "on-demand-stream": false
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "required": {},
    "type": "labels",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "name": "Another great label",
      "children-count": 0,
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "description": "description",
      "logo": "logo"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "products": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

application/vnd.api+json

Delete a label

DELETE

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

/labels/{id}

Delete a label by its ID.

Delete a label › path Parameters

id

string · required

The label ID

Delete a label › Responses

Label deleted successfully

No data returned

Companies Products

Labelcamp API v2

Labels

Label management and configuration

List labels

GET

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

/labels

Retrieve a list of labels with optional filtering.

List labels › query Parameters

filter[distributor-id]

string

Filter by distributor ID

filter[company-id]

string

Filter by company ID

filter[product-id]

string

Filter by product ID

filter[product-genre-id]

string

Filter by product genre ID

filter[name]

string

Filter by label name

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 labels › Responses

List of labels

LabelResource[]

PaginationMeta

GET/labels

curl https://api.idol.io/api/v2/labels \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "type": "labels",
      "id": "1",
      "attributes": {
        "created-at": "2023-01-15T10:00:00Z",
        "updated-at": "2023-01-15T10:00:00Z",
        "name": "Another great label",
        "children-count": 0,
        "usage": {
          "download": true,
          "on-demand-stream": true,
          "non-interactive-stream": true,
          "copy-scan": true
        },
        "description": "An independent music label",
        "logo": "https://example.com/logos/label.png"
      },
      "relationships": {
        "company": {
          "data": {
            "type": "companies",
            "id": "123"
          }
        },
        "products": {
          "data": []
        },
        "rights": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pages": 1,
      "count": 1
    }
  }
}

json

application/vnd.api+json

Create a label

POST

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

/labels

Create a new label associated with a company.

Create a label › Request Body

LabelCreateRequest

LabelResource · required

Create a label › Responses

Label created successfully

LabelResource

POST/labels

curl https://api.idol.io/api/v2/labels \
  --request POST \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "labels",
    "attributes": {
      "name": "My New Label",
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      }
    },
    "relationships": {
      "for-company": {
        "data": {
          "type": "companies",
          "id": "123"
        }
      }
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "labels",
    "attributes": {
      "name": "My New Label",
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      }
    },
    "relationships": {
      "for-company": {
        "data": {
          "type": "companies",
          "id": "123"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "required": {},
    "type": "labels",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "name": "Another great label",
      "children-count": 0,
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "description": "description",
      "logo": "logo"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "products": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

application/vnd.api+json

Get a specific label

GET

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

/labels/{id}

Retrieve a single label by its ID.

Get a specific label › path Parameters

id

string · required

The label ID

Get a specific label › Responses

A single label

LabelResource

Update a label

PUT

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

/labels/{id}

Update an existing label's attributes.

Update a label › path Parameters

id

string · required

The label ID

Update a label › Request Body

LabelUpdateRequest

LabelResource · required

Update a label › Responses

Label updated successfully

LabelResource

PUT/labels/{id}

curl https://api.idol.io/api/v2/labels/:id \
  --request PUT \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "data": {
    "type": "labels",
    "id": "1",
    "attributes": {
      "name": "Updated Label Name",
      "usage": {
        "download": true,
        "on-demand-stream": false
      }
    }
  }
}'

Example Request Body

{
  "data": {
    "type": "labels",
    "id": "1",
    "attributes": {
      "name": "Updated Label Name",
      "usage": {
        "download": true,
        "on-demand-stream": false
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "required": {},
    "type": "labels",
    "id": "id",
    "attributes": {
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z",
      "name": "Another great label",
      "children-count": 0,
      "usage": {
        "download": true,
        "on-demand-stream": true,
        "non-interactive-stream": true,
        "copy-scan": true
      },
      "description": "description",
      "logo": "logo"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "products": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      },
      "rights": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

application/vnd.api+json

Delete a label

DELETE

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

/labels/{id}

Delete a label by its ID.

Delete a label › path Parameters

id

string · required

The label ID

Delete a label › Responses

Label deleted successfully

No data returned

Companies Products