List Companies
GET/companies
List Companies
Request
Query Parameters
Number of items to return
Number of items to skip
Id
ID#
Campaign
Tags
Type
Name
Description
Timezone
Phone
Website
TripAdvisor
Fax
Country
State
Members
Groups
Bookings
Total
Created At
Updated At
Deleted At
Deleted
Created By
Updated By
Deleted By
Brokers
Numbers
Possible values: [id, clientId, campaignId, tags, type, name, description, timezone, email, phone, website, facebook, twitter, instagram, tripadvisor, whatsapp, fax, country, state, members, groups, bookings, totalSpend, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy, brokers, numbers]
Possible values: [brokers]
Responses
- 200
List of Companies
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Tags
Type
Possible values: [Company, Agency, Broker, Association, Club, Group, Other]
Name
Description
Timezone
Phone
Website
TripAdvisor
Fax
Country
State
Brokers
Numbers
Id
ID#
Campaign
Members
Groups
Bookings
Total
Created At
Updated At
Deleted At
Deleted
Created By
Updated By
Deleted By
[
{
"tags": "string",
"type": "Company",
"name": "string",
"description": "string",
"timezone": "string",
"email": "string",
"phone": "string",
"website": "string",
"facebook": "string",
"twitter": "string",
"instagram": "string",
"tripadvisor": "string",
"whatsapp": "string",
"fax": "string",
"country": "string",
"state": "string",
"brokers": "string",
"numbers": "string",
"id": "string",
"clientId": "string",
"campaignId": "string",
"members": 0,
"groups": 0,
"bookings": 0,
"totalSpend": 0,
"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"deleted": "string",
"createdBy": "string",
"updatedBy": "string",
"deletedBy": "string"
}
]