API Documentation
Apps
- Overview
- Companies
- Experiences
- Members
- Memberships
- Products
- Payments
- Reviews
- Notifications
- Line Items
- App Connections
- Users
- Feed Content Items
- Inbound Webhooks
- Inbound Webhook Filters
- GETRetrieve the current app
- GETCheck Access
Company
- Overview
- Memberships
- Products
- Payments
- Reviews
- Users
- GETRetrieve the current company
Me
- Overview
- Memberships
- Products
- Payments
- Reviews
- Experiences
- Companies
- POSTCreate an OAuth Token
- GETRetrieve the current user
- GETList a User's social accounts
Chat
- Webhooks
Companies
Retrieve a Company
Returns a company
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
App API key for /v5/app and /v5/company endpoints
Path Parameters
The ID of the Company, which will look like biz_*************
Response
200
application/json
A successful response
The response is of type object
.
Was this page helpful?
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>"
}
}
Assistant
Responses are generated using AI and may contain mistakes.