Skip to main content

Get all users in an organization

GET 

/v1/organizations/:organizationId/users

Get all users in an organization

Request

Path Parameters

    organizationId stringrequired

Query Parameters

    page numberrequired

    Possible values: >= 1

    Default value: 1

    Page number starting from 1.

    Example: 1
    limit numberrequired

    Possible values: >= 1 and <= 100

    Default value: 10

    Limit the number of results returned. Default is 10.

    Example: 10
    role stringrequired

    Possible values: [OWNER, ADMIN, MEMBER]

    The role of the user within the organization.

    state stringrequired

    Possible values: [INVITED, ACCEPTED]

    The user's status in the organization.

    email stringrequired

Responses

Successfully fetched all users and their roles in the organization.

Schema
    users object[]required

    List of users and their roles within the organization.

  • Array [
  • user object
    id stringrequired

    The unique identifier of the user.

    email stringrequired

    The email of the user.

    role stringrequired

    Possible values: [OWNER, ADMIN]

    The role of the user within the organization.

    state stringrequired

    Possible values: [INVITED, ACCEPTED]

    The user's status in the organization.

  • ]
  • metadata object
    currentPage numberrequired

    The current page number.

    limit numberrequired

    Number of items per page.

    total numberrequired

    Total number of items.

    nextPage numbernullablerequired

    The next page number, or null if this is the last page.

    previousPage numbernullablerequired

    The previous page number, or null if this is the first page.

Loading...