Company

List Companies

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

Headers

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

200

{
  "data": [
    {
      "id": "<ID>",
      "type": "companies",
      "links": {
        "self": "https://api.idol.io/api/v2/companies/<ID>"
      },
      "attributes": {
        "created-at": "2024-11-18T08:07:13.000+01:00",
        "updated-at": "2024-02-21T18:06:19.311+01:00",
        "name": "Demo Company"
      },
      "relationships": {
        "distributor": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/distributor",
            "related": "https://api.idol.io/api/v2/companies/<ID>/distributor"
          },
          "data": {
            "type": "distributors",
            "id": "<ID>"
          }
        },
        "user": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/user",
            "related": "https://api.idol.io/api/v2/companies/<ID>/user"
          },
          "data": null
        },
        "labels": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/labels",
            "related": "https://api.idol.io/api/v2/companies/<ID>/labels"
          }
        },
        "rights": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/rights",
            "related": "https://api.idol.io/api/v2/companies/<ID>/rights"
          }
        },
        "sales-company-contrats": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/sales-company-contrats",
            "related": "https://api.idol.io/api/v2/companies/<ID>/sales-company-contrats"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "companies",
      "links": {
        "self": "https://api.idol.io/api/v2/companies/<ID>"
      },
      "attributes": {
        "created-at": "2024-04-08T15:11:05.285+02:00",
        "updated-at": "2024-05-22T14:20:21.430+02:00",
        "name": "Record Company"
      },
      "relationships": {
        "distributor": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/distributor",
            "related": "https://api.idol.io/api/v2/companies/<ID>/distributor"
          },
          "data": {
            "type": "distributors",
            "id": "<ID>"
          }
        },
        "user": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/user",
            "related": "https://api.idol.io/api/v2/companies/<ID>/user"
          },
          "data": {
            "type": "users",
            "id": "<ID>"
          }
        },
        "labels": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/labels",
            "related": "https://api.idol.io/api/v2/companies/<ID>/labels"
          }
        },
        "rights": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/rights",
            "related": "https://api.idol.io/api/v2/companies/<ID>/rights"
          }
        },
        "sales-company-contrats": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/sales-company-contrats",
            "related": "https://api.idol.io/api/v2/companies/<ID>/sales-company-contrats"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "companies",
      "links": {
        "self": "https://api.idol.io/api/v2/companies/<ID>"
      },
      "attributes": {
        "created-at": "2024-08-28T13:29:04.523+02:00",
        "updated-at": "2024-04-09T20:33:43.066+02:00",
        "name": "Music biz"
      },
      "relationships": {
        "distributor": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/distributor",
            "related": "https://api.idol.io/api/v2/companies/<ID>/distributor"
          },
          "data": {
            "type": "distributors",
            "id": "<ID>"
          }
        },
        "user": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/user",
            "related": "https://api.idol.io/api/v2/companies/<ID>/user"
          },
          "data": null
        },
        "labels": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/labels",
            "related": "https://api.idol.io/api/v2/companies/<ID>/labels"
          }
        },
        "rights": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/rights",
            "related": "https://api.idol.io/api/v2/companies/<ID>/rights"
          }
        },
        "sales-company-contrats": {
          "links": {
            "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/sales-company-contrats",
            "related": "https://api.idol.io/api/v2/companies/<ID>/sales-company-contrats"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 8,
    "page-count": 3
  },
  "links": {
    "first": "https://api.idol.io/api/v2/companies?page%5Bnumber%5D=1&page%5Bsize%5D=3",
    "next": "https://api.idol.io/api/v2/companies?page%5Bnumber%5D=2&page%5Bsize%5D=3",
    "last": "https://api.idol.io/api/v2/companies?page%5Bnumber%5D=3&page%5Bsize%5D=3"
  }
}

Filter resources

Products

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

Labels

Get Company

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

Path Parameters

Name	Type	Description
id*	number	ID of the Company

Headers

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

200

{
  "data": {
    "id": "<ID>",
    "type": "companies",
    "links": {
      "self": "https://api.idol.io/api/v2/companies/<ID>"
    },
    "attributes": {
      "created-at": "2024-11-18T08:07:13.000+01:00",
      "updated-at": "2024-02-21T18:06:19.311+01:00",
      "name": "Demo Company"
    },
    "relationships": {
      "distributor": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/distributor",
          "related": "https://api.idol.io/api/v2/companies/<ID>/distributor"
        },
        "data": {
          "type": "distributors",
          "id": "<ID>"
        }
      },
      "user": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/user",
          "related": "https://api.idol.io/api/v2/companies/<ID>/user"
        },
        "data": null
      },
      "labels": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/labels",
          "related": "https://api.idol.io/api/v2/companies/<ID>/labels"
        }
      },
      "rights": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/rights",
          "related": "https://api.idol.io/api/v2/companies/<ID>/rights"
        }
      },
      "sales-company-contrats": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/sales-company-contrats",
          "related": "https://api.idol.io/api/v2/companies/<ID>/sales-company-contrats"
        }
      }
    }
  }
}

Create Company

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

Headers

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

Request Body

Name	Type	Description
distributor*	object	Distributor object
labels	object	Labels object
rights	object	Rights object
name*	string	Company test API

200

{
  "data": {
    "id": "<ID>",
    "type": "companies",
    "links": {
      "self": "https://api.idol.io/api/v2/companies/<ID>"
    },
    "attributes": {
      "created-at": "2024-07-10T10:49:51.607+02:00",
      "updated-at": "2024-07-10T10:49:51.607+02:00",
      "name": "Demo Company"
    },
    "relationships": {
      "distributor": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/distributor",
          "related": "https://api.idol.io/api/v2/companies/<ID>/distributor"
        },
        "data": {
          "type": "distributors",
          "id": "<ID>"
        }
      },
      "user": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/user",
          "related": "https://api.idol.io/api/v2/companies/<ID>/user"
        },
        "data": null
      },
      "labels": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/labels",
          "related": "https://api.idol.io/api/v2/companies/<ID>/labels"
        }
      },
      "rights": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/rights",
          "related": "https://api.idol.io/api/v2/companies/<ID>/rights"
        }
      },
      "sales-company-contrats": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/sales-company-contrats",
          "related": "https://api.idol.io/api/v2/companies/<ID>/sales-company-contrats"
        }
      }
    }
  }
}

Update Company

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

Path Parameters

Name	Type	Description
id*	number	ID of the Company

Headers

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

Request Body

Name	Type	Description
distributor*	object	Distributor object
labels	object	Labels object
rights	object	Rights object
name*	string	Company test API

200

{
  "data": {
    "id": "<ID>",
    "type": "companies",
    "links": {
      "self": "https://api.idol.io/api/v2/companies/<ID>"
    },
    "attributes": {
      "created-at": "2024-07-10T10:49:51.607+02:00",
      "updated-at": "2024-07-10T10:49:51.607+02:00",
      "name": "Demo Company",
    },
    "relationships": {
      "distributor": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/distributor",
          "related": "https://api.idol.io/api/v2/companies/<ID>/distributor"
        },
        "data": {
          "type": "distributors",
          "id": "<ID>"
        }
      },
      "user": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/user",
          "related": "https://api.idol.io/api/v2/companies/<ID>/user"
        },
        "data": null
      },
      "labels": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/labels",
          "related": "https://api.idol.io/api/v2/companies/<ID>/labels"
        }
      },
      "rights": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/rights",
          "related": "https://api.idol.io/api/v2/companies/<ID>/rights"
        }
      },
      "sales-company-contrats": {
        "links": {
          "self": "https://api.idol.io/api/v2/companies/<ID>/relationships/sales-company-contrats",
          "related": "https://api.idol.io/api/v2/companies/<ID>/sales-company-contrats"
        }
      }
    }
  }
}