Skip to main content
POST
/
v1
/
companies
Create company
curl --request POST \
  --url https://api.hyperline.co/v1/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme",
  "address": {
    "name": "Acme",
    "line1": "5 rue de Paradis",
    "line2": null,
    "city": "Paris",
    "zip": "75010",
    "state": "CA",
    "country": "FR"
  }
}
'
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

Company name.

Example:

"Acme"

​
address
object
required

Address of the default invoicing entity

Response

201 - application/json
​
id
string
required

Company ID.

Example:

"cli_DKL4Xcb5VSa8CQ"

​
name
string
required

Company name.

Example:

"Acme"

​
logo_url
string | null
required

Logo URL of the default invoicing entity.

​
favicon_url
string | null
required

Favicon URL of the default invoicing entity.

​
address
object
required

Address of the default invoicing entity