Skip to main content

List Organization Members

GET 
/v2/organizations/:organizationId/members

This endpoint returns the list of Members that belongs to the given Organization, identified by the organizationId parameter.

The results may vary based on the access level of the user who calls the endpoint:

  • When it's called with Organization Admin privileges, the result will contain each member in the Organization.
  • When it's called without Organization Admin privileges, the result will contain each Organization Admin along with members of those products where the caller has Team members and permission groups (canManageMembers) permission.

Request​

Path Parameters

    organizationId uuidrequired

    The identifier of the Organization.

Responses​

Schema

    admins

    object[]

    nullable

    List of Organization Admins.

  • Array [

    • userId stringnullable

    Identifier of the Organization Admin.

    fullName stringnullable

    Name of the Organization Admin.

    email stringnullable

    Email of the OrganizationAdmin.

    twoFactorEnabled boolean

    Determines whether 2FA is enabled for the Organization Admin.

  • ]

    • billingManagers

    object[]

    nullable

    List of Billing Managers.

  • Array [

    • userId stringnullable

    Identifier of the Organization Admin.

    fullName stringnullable

    Name of the Organization Admin.

    email stringnullable

    Email of the OrganizationAdmin.

    twoFactorEnabled boolean

    Determines whether 2FA is enabled for the Organization Admin.

  • ]

    • members

    object[]

    nullable

    List of Organization Members.

  • Array [

    • userId stringnullable

    Identifier of the Organization Admin.

    fullName stringnullable

    Name of the Organization Admin.

    email stringnullable

    Email of the OrganizationAdmin.

    twoFactorEnabled boolean

    Determines whether 2FA is enabled for the Organization Admin.

    permissions

    object[]

    nullable

    The permissions of the Member.

  • Array [

    • product

    object

    Describes the Member's Product.

    productId uuid

    Identifier of the Member's Product.

    name stringnullable

    Name of the Member's Product.

    permissionGroup

    object

    Describes the Member's Permission Group within a Product.

    permissionGroupId int64

    Identifier of the Member's Permission Group.

    name stringnullable

    Name of the Member's Permission Group.

  • ]

  • ]

Loading...