Skip to main content

List Company Groups

GET 
/institutions/:institutionId/groups

List Company Groups

Request​

Path Parameters

    institutionId stringrequired

Query Parameters

    limit number

    Number of items to return

    offset number

    Number of items to skip

    filter.institutionId string

    Institution

    filter.tags string

    Tags

    filter.parentId string

    Parent

    filter.campaignId string

    Campaign

    filter.name string

    Name

    filter.description string

    Description

    filter.members number

    Members

    filter.bookings number

    Bookings

    filter.totalSpend number

    Total Spend

    filter.id string

    Id

    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: [institutionId, tags, parentId, campaignId, name, description, members, bookings, totalSpend, id, createdAt, updatedAt, deletedAt, deleted, createdBy, updatedBy, deletedBy]

Responses​

List of Company Groups

Schema

  • Array [

    • institutionId string

    Institution

    tags string

    Tags

    parentId string

    Parent

    campaignId string

    Campaign

    name string

    Name

    description string

    Description

    members number

    Members

    bookings number

    Bookings

    totalSpend number

    Total Spend

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