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
- GETGet quotes
- POSTCreate quote
- GETGet quote
- GETDownload quote
- POSTSend quote
- POSTVoid quote
- GETDownload quote file
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCancel subscription
- POSTReinstate subscription
- POSTPause subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- PUTUpdate subscription
- POSTRefresh seat products
Analytics
Companies
Custom properties
Customers
Customers > Credits
Integrations
Invoices
Invoicing entities
Payments
Price configurations
Quotes
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.
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.favicon_url
string | null
requiredCompany favicon 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
enum<string> | null
Two-letter country code in ISO format. See ISO 3166 Alpha 2.
Available options:
AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW