Skip to main content

List Brokers

GET 
/brokers

List Brokers

Request​

Query Parameters

    limit number

    Number of items to return

    offset number

    Number of items to skip

    filter.id string

    Id

    filter.name string

    Name

    filter.clientId string

    Broker ID

    filter.tags string

    Tags

    filter.type string

    Type

    filter.firstName string

    First Name

    filter.lastName string

    Last Name

    filter.email string

    Email

    filter.phone string

    Phone

    filter.members number

    Members

    filter.institutions number

    Companies

    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

    include string[]

    Possible values: [id, name, clientId, tags, type, firstName, lastName, email, phone, members, institutions, bookings, totalSpend, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy]

Responses​

List of Brokers

Schema

  • Array [

    • name string

    Name

    tags string

    Tags

    type string

    Type

    Possible values: [Broker, Agent, Agency, Consultant, Other]

    firstName string

    First Name

    lastName string

    Last Name

    email string

    Email

    phone string

    Phone

    id string

    Id

    clientId string

    Broker ID

    members number

    Members

    institutions number

    Companies

    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...