Skip to content

Company

A company is a record-label company. It belongs to a group and a distributor, and groups labels and products. This resource is read-only.

Lists Companies

GET https://domain.com/api/v1/companies

Headers

Name Type Description
Authorization* String Bearer \
Content-Type* String application/vnd.api+json

Response — 200 OK

{
  "data": [
    {
      "type": "companies",
      "id": "<ID>",
      "attributes": {
        "name": "Music Company"
      },
      "relationships": {
        "group": {
          "links": {
            "related": "https://domain.com/api/v1/companies/<ID>/group",
            "self": "https://domain.com/api/v1/companies/<ID>/relationships/group"
          }
        },
        "distributor": {
          "links": {
            "related": "https://domain.com/api/v1/companies/<ID>/distributor",
            "self": "https://domain.com/api/v1/companies/<ID>/relationships/distributor"
          }
        },
        "labels": {
          "links": {
            "related": "https://domain.com/api/v1/companies/<ID>/labels",
            "self": "https://domain.com/api/v1/companies/<ID>/relationships/labels"
          }
        },
        "products": {
          "links": {
            "related": "https://domain.com/api/v1/companies/<ID>/products",
            "self": "https://domain.com/api/v1/companies/<ID>/relationships/products"
          }
        }
      },
      "links": {
        "self": "https://domain.com/api/v1/companies/<ID>"
      }
    }
  ],
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 20,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://domain.com/api/v1/companies?page[number]=1&page[size]=20",
    "last": "https://domain.com/api/v1/companies?page[number]=1&page[size]=20"
  }
}

Filters

Filter Example
Name /companies?filter[name]=Music Company
ID /companies?filter[id]=1

Get Company

GET https://domain.com/api/v1/companies/:id

Path Parameters

Name Type Description
id* Number Company ID

Headers

Name Type Description
Authorization* String Bearer \
Content-Type* String application/vnd.api+json

Response — 200 OK

{
  "data": {
    "type": "companies",
    "id": "<ID>",
    "attributes": {
      "name": "Music Company"
    },
    "relationships": {
      "group": {
        "links": {
          "related": "https://domain.com/api/v1/companies/<ID>/group",
          "self": "https://domain.com/api/v1/companies/<ID>/relationships/group"
        }
      },
      "distributor": {
        "links": {
          "related": "https://domain.com/api/v1/companies/<ID>/distributor",
          "self": "https://domain.com/api/v1/companies/<ID>/relationships/distributor"
        }
      },
      "labels": {
        "links": {
          "related": "https://domain.com/api/v1/companies/<ID>/labels",
          "self": "https://domain.com/api/v1/companies/<ID>/relationships/labels"
        }
      },
      "products": {
        "links": {
          "related": "https://domain.com/api/v1/companies/<ID>/products",
          "self": "https://domain.com/api/v1/companies/<ID>/relationships/products"
        }
      }
    },
    "links": {
      "self": "https://domain.com/api/v1/companies/<ID>"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "https://domain.com/api/v1/companies/<ID>"
  }
}

Response — 404 Not Found

{
  "jsonapi": {
    "version": "1.0"
  },
  "errors": [
    {
      "status": "404",
      "title": "Not Found"
    }
  ]
}