Companies

Endpointhttps://api.idol.io/api/v2

Company management and organization structure.

Companies represent business entities that own labels and manage music catalog. A company belongs to a distributor and can have multiple labels associated with it.

Use companies to organize your catalog hierarchically within the distributor structure.

List companies

GET

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

/companies

Retrieve a paginated list of companies

List companies › query Parameters

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

filter[product-ids]

string

Comma-separated product IDs to filter companies

filter[label-ids]

string

Comma-separated label IDs to filter companies

List companies › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a company

POST

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

/companies

Create a new company.

Required fields: name, distributor relationship

Create a company › Request Body

object · required

Create a company › Responses

Company created successfully

object

object[]

Related resources included in the response

object

POST/companies

curl --request POST \
  --url https://api.idol.io/api/v2/companies \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "companies",
    "attributes": {
      "name": "My Music Company"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "distributors",
          "id": "1"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "companies",
    "attributes": {
      "name": "My Music Company"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "distributors",
          "id": "1"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get company details

GET

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

/companies/{id}

Retrieve a single company by ID

Get company details › path Parameters

id

string · required

Resource ID

Get company details › query Parameters

include

string

Comma-separated list of related resources to include

Get company details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a company

PUT

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

/companies/{id}

Update an existing company.

Required fields: name, distributor relationship

Update a company › path Parameters

id

string · required

Resource ID

Update a company › Request Body

object · required

Update a company › Responses

Company updated successfully

object

object[]

Related resources included in the response

object

PUT/companies/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/companies/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "companies",
    "id": "id",
    "attributes": {
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "labels": {
        "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": {}
      },
      "sales-company-contrats": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "companies",
    "id": "id",
    "attributes": {
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "labels": {
        "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": {}
      },
      "sales-company-contrats": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete a company

DELETE

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

/companies/{id}

Delete a company

Delete a company › path Parameters

id

string · required

Resource ID

Delete a company › Responses

Company deleted successfully

No data returned

Labels

Labelcamp API v2

Companies

Endpointhttps://api.idol.io/api/v2

Company management and organization structure.

Companies represent business entities that own labels and manage music catalog. A company belongs to a distributor and can have multiple labels associated with it.

Use companies to organize your catalog hierarchically within the distributor structure.

List companies

GET

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

/companies

Retrieve a paginated list of companies

List companies › query Parameters

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

filter[product-ids]

string

Comma-separated product IDs to filter companies

filter[label-ids]

string

Comma-separated label IDs to filter companies

List companies › Responses

Successful response

object[]

Array of resource objects (override with specific resource schema)

object[]

Related resources included in the response

object

Create a company

POST

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

/companies

Create a new company.

Required fields: name, distributor relationship

Create a company › Request Body

object · required

Create a company › Responses

Company created successfully

object

object[]

Related resources included in the response

object

POST/companies

curl --request POST \
  --url https://api.idol.io/api/v2/companies \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "companies",
    "attributes": {
      "name": "My Music Company"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "distributors",
          "id": "1"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "companies",
    "attributes": {
      "name": "My Music Company"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "distributors",
          "id": "1"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

No example specified for this content type

application/vnd.api+json

Get company details

GET

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

/companies/{id}

Retrieve a single company by ID

Get company details › path Parameters

id

string · required

Resource ID

Get company details › query Parameters

include

string

Comma-separated list of related resources to include

Get company details › Responses

Successful response

object

object[]

Related resources included in the response

object

Update a company

PUT

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

/companies/{id}

Update an existing company.

Required fields: name, distributor relationship

Update a company › path Parameters

id

string · required

Resource ID

Update a company › Request Body

object · required

Update a company › Responses

Company updated successfully

object

object[]

Related resources included in the response

object

PUT/companies/{id}

curl --request PUT \
  --url https://api.idol.io/api/v2/companies/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "companies",
    "id": "id",
    "attributes": {
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "labels": {
        "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": {}
      },
      "sales-company-contrats": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "companies",
    "id": "id",
    "attributes": {
      "name": "name",
      "created-at": "2024-08-25T15:00:00Z",
      "updated-at": "2024-08-25T15:00:00Z"
    },
    "relationships": {
      "distributor": {
        "data": {
          "type": "type",
          "id": "id"
        },
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        }
      },
      "labels": {
        "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": {}
      },
      "sales-company-contrats": {
        "data": [
          {
            "type": "type",
            "id": "id"
          }
        ],
        "links": {
          "self": "https://www.example.com/path/to/resource",
          "related": "https://www.example.com/path/to/resource"
        },
        "meta": {}
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Delete a company

DELETE

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

/companies/{id}

Delete a company

Delete a company › path Parameters

id

string · required

Resource ID

Delete a company › Responses

Company deleted successfully

No data returned

Labels