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
List Companies
Returns a collection of companies
GET
/
v5
/
app
/
companies
curl --request GET \
--url https://{defaultHost}/v5/app/companies \
--header 'Authorization: Bearer <token>'
{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"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
Query Parameters
The page number to retrieve
The number of resources to return per page. There is a limit of 50 results per page.
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 \
--header 'Authorization: Bearer <token>'
{
"pagination": {
"current_page": 123,
"total_pages": 123,
"next_page": 123,
"prev_page": 123,
"total_count": 123
},
"data": [
{
"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.