Companies
Get companies
- Documentation
- API Reference
- Integrations
- Changelog
- Blog
- GETGet analytics
- GETGet companies
- GETGet custom properties
- POSTCreate custom property
- PUTUpdate custom property
- DELDelete custom property
- GETGet customers
- POSTCreate customer
- GETGet customer
- PUTUpdate customer
- DELDelete customer
- GETGet customer portal
- PUTArchive customer
- POSTBulk update providers/customers mapping
- GETList credit products
- POSTCreate credit product
- GETGet credit product
- GETList credit transactions
- POSTPurchase credits
- POSTTopup credits
- POSTCreate credits usage
- POSTCreate component token
- GETGet invoices
- POSTCreate one-off invoice
- POSTSends a draft invoice for payment
- GETGet invoice
- GETDownload invoice
- POSTCreate transaction
- GETGet invoicing entities
- POSTCreate invoicing entity
- GETGet invoicing entity
- PUTUpdate invoicing entity
- DELDelete invoicing entity
- POSTCreate payment
- POSTUpdate prices
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- POSTRefresh seat products
Analytics
Companies
Custom properties
Customers
Customers > Credits
Integrations
Invoices
Invoicing entities
Payments
Price configurations
Subscriptions
Companies
Get companies
Retrieve all companies that the authentication token has access to.
GET
/
v1
/
companies
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
curl --request GET \
--url https://api.hyperline.co/v1/companies \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Acme",
"logo_url": "<string>",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}
]
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200 - application/json
meta
object
requiredmeta.total
number
requiredTotal of existing items.
meta.taken
number
requiredNumber of items returned.
meta.skipped
number
requiredNumber of items skipped.
data
object[]
requiredList of Company.
data.id
string
requiredCompany ID.
data.name
string
requiredCompany name.
data.logo_url
string | null
requiredCompany logo URL.
data.address
object
requiredCompany billing address
data.address.name
string | null
Address name.
data.address.line1
string | null
Address first line.
data.address.line2
string | null
Address second line (optional).
data.address.city
string | null
Address city.
data.address.zip
string | null
Address ZIP code.
data.address.state
string | null
Address state (only for US country).
data.address.country
string | null
Two-letter country code in ISO format. See ISO 3166 Alpha 2.
curl --request GET \
--url https://api.hyperline.co/v1/companies \
--header 'Authorization: Bearer <token>'
{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "cou_DKL4Xcb5VSa8CQ",
"name": "Acme",
"logo_url": "<string>",
"address": {
"name": "Acme",
"line1": "5 rue de Paradis",
"line2": "<string>",
"city": "Paris",
"zip": "75010",
"state": "<string>",
"country": "FR"
}
}
]
}