API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Companies
Get companies
Retrieve all companies that the authentication token has access to.
GET
/
v1
/
companies
curl --request GET \
--url https://api.hyperline.co/v1/companies \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Acme",
"logo_url": "<string>",
"favicon_url": "<string>",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.hyperline.co/v1/companies \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 0
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Acme",
"logo_url": "<string>",
"favicon_url": "<string>",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.