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
List Companies
Returns a collection of companies
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
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
The date the company was created as a unix timestamp.
The ID of the company object, which will look like biz_*************
The date the user was created as a unix timestamp.
The ID of the user, which will look like user_*************
The username of the user
The email of the user
The first and last name of the user.
The URL of the user's profile picture
The URL of the user's profile picture at 128x128 pixels
The URL of the user's profile picture at 32x32 pixels
The URL of the user's profile picture at 64x64 pixels
The title of the company
The ID of the company, which will look like biz_*************
The email of the authorized user
The ID of the user, which will look like user_*************
The role of the user
The date the user was created as a unix timestamp.
The ID of the user, which will look like user_*************
The username of the user
The email of the user
The first and last name of the user.
The URL of the user's profile picture
The URL of the user's profile picture at 128x128 pixels
The URL of the user's profile picture at 32x32 pixels
The URL of the user's profile picture at 64x64 pixels
The username of the authorized user
Whether or not the company has a payment method on file to charge for metered billing usage.
The URL of the company's image
The route to the company's first/default page
Was this page helpful?