GET
/
v5
/
me
/
companies
/
{id}
curl --request GET \
  --url https://{defaultHost}/v5/me/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"
  },
  "route": "<string>"
}

Authorizations

​
Authorization
string
header
required

User OAuth token for /v5/me endpoints

Headers

​
x-include-admin
boolean

Path Parameters

​
id
string
required

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

Response

200 - application/json
company retrieved
​
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

​
image_url
string | null

The URL of the company's image

​
authorized_user
object
​
route
string | null

The route to the company's first/default page

Was this page helpful?