Skip to main content

List Broker Commissions

GET 
/brokers/:brokerId/commissions

List Broker Commissions

Request​

Path Parameters

    brokerId stringrequired

Query Parameters

    limit number

    Number of items to return

    offset number

    Number of items to skip

    filter.id string

    Id

    filter.campaignId string

    Campaign

    filter.type string

    Type

    filter.value number

    Value

    filter.effective string

    Effective

    filter.expires string

    Expires

    filter.tags string

    Tags

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

    Institution

    include string[]

    Possible values: [id, campaignId, type, value, effective, expires, tags, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy, institutionId]

Responses​

List of Broker Commissions

Schema

  • Array [

    • campaignId string

    Campaign

    type string

    Type

    Possible values: [Fixed, Percentage]

    value number

    Value

    effective string

    Effective

    expires string

    Expires

    tags string

    Tags

    institutionId string

    Institution

    id string

    Id

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