Skip to main content

List organization groups​

Get all groups that belong to an organization. The results can be filtered by state which can be either be enabled or disabled.

Path Parameters
    orgId string required
Query Parameters
    state string

    The state of the group to filter by. It can be enabled or disabled.

    groupIds string[]
    withMembers boolean
Responses

A successful response.

Schema
    groups object[]
  • Array [
    • id string
    name string
    title string
    orgId string
    metadata object
    createdAt date-time

    The time the group was created.

    updatedAt date-time

    The time the group was last updated.

    users object[]
  • Array [
    • id string
    name can either be empty or must start with a character

    Unique name of the user.

    title string

    Name of the user.

    email string
    metadata object
    createdAt date-time

    The time the user was created.

    updatedAt date-time

    The time the user was last updated.

    state string

    The state of the user (enabled or disabled).

    avatar string

    The base64 encoded image string of the user avatar. Should be less than 2MB.

  • ]
  • ]
Loading...