Skip to main content

List all users​

Lists all the users from all the organizations in a Frontier instance. It can be filtered by keyword, organization, group and state.

Query Parameters
    pageSize int32

    The maximum number of users to return per page. The default is 50.

    pageNum int32

    The page number to return. The default is 1.

    keyword string

    The keyword to search for. It can be a user's name, email,metadata or id.

    orgId string

    The organization id to filter by.

    groupId string

    The group id to filter by.

    state string

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

Responses

A successful response.

Schema
    count int32
    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...