Skip to main content

List Companies

GET 
/companies

List Companies

Request​

Query Parameters

    limit number

    Number of items to return

    offset number

    Number of items to skip

    filter.id string

    Id

    filter.clientId string

    ID#

    filter.campaignId string

    Campaign

    filter.tags string

    Tags

    filter.type string

    Type

    filter.name string

    Name

    filter.description string

    Description

    filter.timezone string

    Timezone

    filter.email string

    Email

    filter.phone string

    Phone

    filter.website string

    Website

    filter.facebook string

    Facebook

    filter.twitter string

    Twitter

    filter.instagram string

    Instagram

    filter.tripadvisor string

    TripAdvisor

    filter.whatsapp string

    WhatsApp

    filter.fax string

    Fax

    filter.country string

    Country

    filter.state string

    State

    filter.members number

    Members

    filter.groups number

    Groups

    filter.bookings number

    Bookings

    filter.totalSpend number

    Total

    filter.createdAt string

    Created At

    filter.updatedAt string

    Updated At

    filter.deletedAt string

    Deleted At

    filter.deleted string

    Deleted

    filter.createdBy string

    Created By

    filter.updatedBy string

    Updated By

    filter.deletedBy string

    Deleted By

    filter.brokers string

    Brokers

    filter.numbers string

    Numbers

    include string[]

    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]

    expand string[]

    Possible values: [brokers]

Responses​

List of Companies

Schema

  • Array [

    • tags string

    Tags

    type string

    Type

    Possible values: [Company, Agency, Broker, Association, Club, Group, Other]

    name string

    Name

    description string

    Description

    timezone string

    Timezone

    email string

    Email

    phone string

    Phone

    website string

    Website

    facebook string

    Facebook

    twitter string

    Twitter

    instagram string

    Instagram

    tripadvisor string

    TripAdvisor

    whatsapp string

    WhatsApp

    fax string

    Fax

    country string

    Country

    state string

    State

    brokers string

    Brokers

    numbers string

    Numbers

    id string

    Id

    clientId string

    ID#

    campaignId string

    Campaign

    members number

    Members

    groups number

    Groups

    bookings number

    Bookings

    totalSpend number

    Total

    createdAt string

    Created At

    updatedAt string

    Updated At

    deletedAt string

    Deleted At

    deleted string

    Deleted

    createdBy string

    Created By

    updatedBy string

    Updated By

    deletedBy string

    Deleted By

  • ]

Loading...