Skip to main content

List user groups​

Lists all the groups a user belongs to across all organization in Frontier. To get the groups of a user in a specific organization, use the org_id filter in the query parameter.

Path Parameters
    id string required

    The unique ID of the user to get groups for.

Query Parameters
    orgId string

    The organization ID to filter groups by. If not provided, groups from all organizations are returned.

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