> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List an organization's members

> Return one page of an organization's members, oldest membership first. Each member carries
their roles in the organization and whether they have signed in yet. The organization is
identified by the `org_id` path parameter alone. The `x-hh-org-id` header does not
participate.

Available on self-hosted deployments that do not enable an SSO group scheme. Elsewhere this
operation returns 404. An API key that carries a membership permission can carry no
permission other than the roles and membership permissions, and is created on an
organization.




## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/control_plane_openapi.yaml get /v1/orgs/{org_id}/members
openapi: 3.1.0
info:
  title: HoneyHive Control Plane API
  description: >
    Manage HoneyHive control-plane resources: organizations with their roles,
    templates and

    members, workspaces with their templates and members, projects with their
    members and

    alerts, and read org usage.


    Authentication requires a fine-grained control-plane API key (values

    start with `hh_fgcp_`), sent as `Authorization: Bearer <api-key>`.

    Project API keys used with the Data Plane API will not work here. Create

    a key in the HoneyHive app under an organization's or workspace's

    **Settings → API Keys**, or see

    [Authorization](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript#authorization)

    for details.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.19.0
servers:
  - url: https://api.cp.us.honeyhive.ai
security: []
tags:
  - name: Alerts
    description: >
      Define and manage alerts. Alerts evaluate event metrics on a schedule and
      trigger notifications when configured thresholds are crossed.
  - name: Org Members
    description: >
      List an organization's members, invite people to it, set a member's roles,
      and remove people from it and from everything in it. Available on
      self-hosted deployments that do not enable an SSO group scheme.
  - name: Org Templates
    description: >
      Read and replace an organization's templates manifest, which defines the
      metrics and charts that new projects start with. Each workspace gets its
      own copy when it is created, so a new version reaches an existing
      workspace's projects only where that workspace's manifest merges with the
      organization's.
  - name: Orgs
    description: >
      Read an organization's display name and the email domains whose users join
      it automatically when they sign in, and update its display name.
  - name: Project Members
    description: >
      List a project's members, invite people to it, set a member's roles, and
      remove people from it. Available on self-hosted deployments that do not
      enable an SSO group scheme.
  - name: Projects
    description: >
      Create and manage projects within a workspace. A project is the container
      for the events, datasets, evaluations, and alerts logged against it.
  - name: Roles
    description: >
      Read and replace an organization's roles manifest, which defines its roles
      and the permissions each one grants. Available on self-hosted deployments
      only.
  - name: Usage
    description: >
      Read an organization's usage: events and computed metrics per calendar
      month, and current user, workspace and project counts.
  - name: Virtual Dataplanes
    description: >
      Create and manage virtual data planes. A virtual data plane is a logical
      tenant boundary inside an organization, hosted on a physical cluster;
      several virtual data planes commonly share one cluster. Workspaces live
      inside a virtual data plane.
  - name: Workspace Members
    description: >
      List a workspace's members, invite people to it, set a member's roles, and
      remove people from it and from every project in it. Available on
      self-hosted deployments that do not enable an SSO group scheme.
  - name: Workspace Templates
    description: >
      Read and replace a workspace's templates manifest, which defines the
      metrics and charts that new projects in the workspace start with.
  - name: Workspaces
    description: >
      Read and manage workspaces. A workspace groups the projects belonging to
      one team or environment, and owns the API keys and AI provider secrets its
      projects share.
paths:
  /v1/orgs/{org_id}/members:
    get:
      tags:
        - Org Members
      summary: List an organization's members
      description: >
        Return one page of an organization's members, oldest membership first.
        Each member carries

        their roles in the organization and whether they have signed in yet. The
        organization is

        identified by the `org_id` path parameter alone. The `x-hh-org-id`
        header does not

        participate.


        Available on self-hosted deployments that do not enable an SSO group
        scheme. Elsewhere this

        operation returns 404. An API key that carries a membership permission
        can carry no

        permission other than the roles and membership permissions, and is
        created on an

        organization.
      operationId: listOrgMembers
      parameters:
        - in: path
          name: org_id
          required: true
          schema:
            type: string
          description: The unique identifier of the organization
        - in: query
          name: page
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: 1-indexed page number
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Number of members to return per page
      responses:
        '200':
          description: Members retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMembersResponse'
        '400':
          description: >-
            Invalid pagination parameters, or a query parameter the operation
            does not take
        '404':
          description: >-
            Organization not found, the caller may not list its members, or the
            deployment does not offer member management. The response does not
            say which.
      security:
        - ControlPlaneApiKey: []
components:
  schemas:
    GetMembersResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/Member'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - success
        - data
        - pagination
      additionalProperties: false
    Member:
      type: object
      properties:
        user_id:
          type: string
          description: The member's user id, the same at every scope
        email:
          type: string
          description: The member's email address
        name:
          type:
            - string
            - 'null'
          description: >-
            The member's display name from their identity provider, when it sent
            one
        role_names:
          type: array
          items:
            type: string
          description: The member's roles at this scope
        state:
          type: string
          enum:
            - INVITED
            - ONBOARDED
          description: >-
            `INVITED` until the member first signs in, `ONBOARDED` after. An API
            key cannot remove an `ONBOARDED` member whose organization roles let
            them revoke API keys, or change those roles to ones that do not, so
            an admin role a key grants can be undone with a key only while the
            member is `INVITED`.
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
          description: When the member was added to this scope
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
            - type: 'null'
          description: When the member's membership of this scope last changed
      required:
        - user_id
        - email
        - name
        - role_names
        - state
        - created_at
        - updated_at
      additionalProperties: false
      description: One member of a scope
    Pagination:
      type: object
      properties:
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
        total:
          type: integer
          minimum: 0
        total_unfiltered:
          type: integer
          minimum: 0
        total_pages:
          type: integer
          minimum: 0
        has_next:
          type: boolean
        has_prev:
          type: boolean
      required:
        - page
        - limit
        - total
        - total_unfiltered
        - total_pages
        - has_next
        - has_prev
  securitySchemes:
    ControlPlaneApiKey:
      type: http
      scheme: bearer
      description: >-
        A fine-grained control-plane API key (values begin with `hh_fgcp_`).
        Project API keys used with the Data Plane API will not work here. Create
        one in the HoneyHive app under an organization's or workspace's
        **Settings → API Keys**.

````

## Related topics

- [Org Members](https://docs.honeyhive.ai/v2/cli-reference/ref/org-members.md)
- [Org Members Methods](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/org-members/index.md)
- [Namespaces](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/namespaces.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.