List companies

Retrieve all companies that the authentication token has access to.

GET /v1/companies

List companies

cURL

curl --request GET \
  --url https://api.hyperline.co/v1/companies \
  --header 'Authorization: Bearer <token>'

200

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "cli_DKL4Xcb5VSa8CQ",
      "name": "Acme",
      "logo_url": "<string>",
      "favicon_url": "<string>",
      "address": {
        "name": "Acme",
        "line1": "5 rue de Paradis",
        "line2": null,
        "city": "Paris",
        "zip": "75010",
        "state": "CA",
        "country": "FR"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

meta · object · required

Show child attributes

data · object[] · required

List of Company.

Show child attributes