> ## Documentation Index > Fetch the complete documentation index at: https://pipedream.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List workspace members > List a workspace's members, paginated and searchable by name or email Requires the `members:read` scope. ## OpenAPI ````yaml /conduit/openapi/api.yaml get /conduit.v1.ConduitService/ListWorkspaceMembers openapi: 3.1.0 info: title: Conduit API version: v1 description: | Machine-to-machine API for Conduit workspaces. Authenticate a workspace API client with OAuth 2.0 client credentials at `/oauth/token`, then call these methods with the resulting bearer token. Read-only methods are documented as `GET`, with their JSON request encoded in the `message` query parameter. Mutating methods use `POST` with a JSON body. The server also accepts `POST` for reads. See the API guide for auth, scopes, and error handling. servers: - url: https://conduit.example.com description: Your Conduit instance — replace with your CONDUIT_BASE_URL security: - bearerAuth: [] tags: - name: connectors x-group: Connectors description: Create and manage connectors and the workspace's Pipedream configuration. - name: policies-and-groups x-group: Policies & groups description: Allow policies, groups, group membership, and effective-access debugging. - name: members x-group: Members description: Read the workspace's member roster. - name: single-sign-on x-group: Single sign-on description: Read sanitized workspace identity-provider configuration. - name: provisioning x-group: Provisioning description: Read sanitized SCIM metadata, provisioning rules, and resource mappings. - name: workspace-settings x-group: Workspace settings description: Change general workspace settings. - name: audit-log x-group: Audit log description: Read the workspace audit log. paths: /conduit.v1.ConduitService/ListWorkspaceMembers: get: tags: - members summary: List workspace members description: |- List a workspace's members, paginated and searchable by name or email Requires the `members:read` scope. operationId: ListWorkspaceMembers parameters: - name: Connect-Protocol-Version in: header required: true schema: $ref: '#/components/schemas/connect-protocol-version' - name: Connect-Timeout-Ms in: header schema: $ref: '#/components/schemas/connect-timeout-header' - name: message in: query content: application/json: schema: $ref: '#/components/schemas/conduit.v1.ListWorkspaceMembersRequest' - name: encoding in: query required: true schema: $ref: '#/components/schemas/encoding' - name: base64 in: query schema: $ref: '#/components/schemas/base64' - name: compression in: query schema: $ref: '#/components/schemas/compression' - name: connect in: query schema: $ref: '#/components/schemas/connect' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/conduit.v1.ListWorkspaceMembersResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/connect.error' components: schemas: connect-protocol-version: type: number title: Connect-Protocol-Version enum: - 1 description: Define the version of the Connect protocol const: 1 connect-timeout-header: type: number title: Connect-Timeout-Ms description: Define the timeout, in ms conduit.v1.ListWorkspaceMembersRequest: type: object properties: organizationId: type: string title: organization_id limit: type: integer title: limit format: int32 description: clamped to 100; defaults to 50 offset: type: integer title: offset format: int32 search: type: string title: search description: >- matches member name or email (case-insensitive substring); empty = all userId: type: string title: user_id description: exact-match filter to one member; empty = all title: ListWorkspaceMembersRequest additionalProperties: false encoding: title: encoding enum: - proto - json description: Define which encoding or 'Message-Codec' to use base64: type: boolean title: base64 description: >- Specifies if the message query param is base64 encoded, which may be required for binary data compression: title: compression enum: - identity - gzip - br description: Which compression algorithm to use for this request connect: title: connect enum: - v1 description: Define the version of the Connect protocol conduit.v1.ListWorkspaceMembersResponse: type: object properties: members: type: array items: $ref: '#/components/schemas/conduit.v1.WorkspaceMember' title: members total: type: - integer - string title: total format: int64 description: total members matching the search, across all pages title: ListWorkspaceMembersResponse additionalProperties: false connect.error: type: object properties: code: type: string examples: - not_found enum: - canceled - unknown - invalid_argument - deadline_exceeded - not_found - already_exists - permission_denied - resource_exhausted - failed_precondition - aborted - out_of_range - unimplemented - internal - unavailable - data_loss - unauthenticated description: >- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. message: type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. details: type: array items: $ref: '#/components/schemas/connect.error_details.Any' description: >- A list of messages that carry the error details. There is no limit on the number of messages. title: Connect Error additionalProperties: true description: >- Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation conduit.v1.WorkspaceMember: type: object properties: id: type: string title: id description: membership id userId: type: string title: user_id role: type: string title: role description: workspace membership role instanceRole: type: string title: instance_role description: >- instance role (user/admin); empty unless the caller is an instance admin name: type: string title: name email: type: string title: email image: type: string title: image createdAt: type: - integer - string title: created_at format: int64 description: unix seconds nameEdit: $ref: '#/components/schemas/conduit.v1.MemberNameEdit' title: name_edit description: whether the caller may rename this member, and why not title: WorkspaceMember additionalProperties: false description: |- One workspace member. instance_role is the user's instance-level role (users.role: "user"/"admin"), distinct from role (the workspace membership role: "owner"/"admin"/"member"). It is instance-scoped data, so it is populated only when the caller is an instance admin and empty otherwise — a workspace admin's gate proves nothing at instance scope. connect.error_details.Any: type: object properties: type: type: string description: >- A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. This is used to determine the schema of the data in the `value` field and is the discriminator for the `debug` field. value: type: string format: binary description: >- The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field. debug: oneOf: - type: object title: Any additionalProperties: true description: Detailed error information. discriminator: propertyName: type title: Debug description: >- Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic. additionalProperties: true description: >- Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details. conduit.v1.MemberNameEdit: type: string title: MemberNameEdit enum: - MEMBER_NAME_EDIT_UNSPECIFIED - MEMBER_NAME_EDIT_ALLOWED - MEMBER_NAME_EDIT_OUTRANKED - MEMBER_NAME_EDIT_NOT_OWNED - MEMBER_NAME_EDIT_DIRECTORY description: >- Whether a caller may rename a workspace member (UpdateWorkspaceMemberName). The refusals are checked in this order, so a member who is several at once reports the first. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: opaque ````