GET
/
v5
/
app
/
companies
/
{id}
curl --request GET \
  --url https://{defaultHost}/v5/app/companies/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "created_at": 123,
  "title": "<string>",
  "image_url": "<string>",
  "authorized_user": {
    "id": "<string>",
    "user_id": "<string>",
    "role": "owner",
    "company_id": "<string>",
    "user": {
      "id": "<string>",
      "name": "<string>",
      "username": "<string>",
      "email": "<string>",
      "profile_pic_url": "<string>",
      "created_at": 123,
      "profile_pic_url_32": "<string>",
      "profile_pic_url_64": "<string>",
      "profile_pic_url_128": "<string>"
    }
  },
  "has_payment_method": true,
  "route": "<string>",
  "owner": {
    "id": "<string>",
    "name": "<string>",
    "username": "<string>",
    "email": "<string>",
    "profile_pic_url": "<string>",
    "created_at": 123,
    "profile_pic_url_32": "<string>",
    "profile_pic_url_64": "<string>",
    "profile_pic_url_128": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Path Parameters

​
id
string
required

The ID of the Company, which will look like biz_*************

Response

200
application/json
A successful response
​
id
string
required

The ID of the company object, which will look like biz_*************

​
created_at
number
required

The date the company was created.

​
title
string
required

The title of the company

​
owner
object
required
​
image_url
string | null

The URL of the company's image

​
authorized_user
object
​
has_payment_method
boolean

Whether or not the company has a payment method on file to charge for metered billing usage.

​
route
string | null

The route to the company's first/default page