> ## Documentation Index > Fetch the complete documentation index at: https://docs.nvisy.com/llms.txt > Use this file to discover all available pages before exploring further. # List members > Returns a paginated list of workspace members with their roles and status. ## OpenAPI ````yaml /api-reference/openapi.json get /workspaces/{workspaceSlug}/members/ openapi: 3.1.0 info: title: Nvisy API summary: Document processing and annotation platform description: >- Nvisy provides intelligent document processing, annotation, and analysis capabilities. This API enables document upload, OCR processing, embedding generation, and semantic search across your document collections. termsOfService: https://nvisy.com/legal/terms-of-service contact: name: Nvisy Support url: https://nvisy.com email: hello@nvisy.com license: name: Proprietary url: https://nvisy.com/license version: 0.1.0 servers: [] security: [] tags: - name: Accounts description: Account management and profile operations - name: Authentication description: Login, signup, and token management - name: Workspaces description: Workspace creation and management - name: Files description: File upload, download, and management - name: Members description: Workspace member management - name: Invites description: Workspace invitation handling - name: API Tokens description: API token management - name: Connections description: External provider connections - name: Pipelines description: Redaction pipeline configuration - name: Pipeline Runs description: Pipeline run execution and review - name: Policies description: Redaction policy configuration - name: Webhooks description: Webhook configuration - name: Notifications description: Account notification management - name: Health description: Service health checks paths: /workspaces/{workspaceSlug}/members/: get: tags: - Members summary: List members description: >- Returns a paginated list of workspace members with their roles and status. parameters: - in: path name: workspaceSlug description: URL-safe workspace identifier. required: true schema: description: URL-safe workspace identifier. type: string style: simple - in: query name: has2fa description: Filter by 2FA status. schema: description: Filter by 2FA status. type: boolean style: form - in: query name: order description: Sort order (asc or desc). schema: $ref: '#/components/schemas/SortOrder' description: Sort order (asc or desc). style: form - in: query name: role description: Filter by workspace role. schema: $ref: '#/components/schemas/WorkspaceRole' description: Filter by workspace role. style: form - in: query name: sortBy description: Sort by field. schema: $ref: '#/components/schemas/MemberSortField' description: Sort by field. style: form - in: query name: after description: |- Cursor pointing to the last item of the previous page. Obtain this from the `nextCursor` field in the response. schema: description: |- Cursor pointing to the last item of the previous page. Obtain this from the `nextCursor` field in the response. type: string style: form - in: query name: limit description: 'The maximum number of records to return (1-100, default: 20).' schema: description: 'The maximum number of records to return (1-100, default: 20).' type: integer format: uint32 maximum: 100 minimum: 1 style: form responses: '200': description: >- Generic paginated response wrapper. Provides a consistent structure for all paginated API responses with cursor-based pagination support. When `next_cursor` is present, there are more items to fetch. content: application/json: schema: $ref: '#/components/schemas/MemberPage' '401': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: SortOrder: description: Sort order direction. oneOf: - description: Ascending order (A-Z, oldest first, smallest first). type: string const: asc - description: Descending order (Z-A, newest first, largest first). type: string const: desc WorkspaceRole: description: >- Defines the role and permission level of a workspace member. This enumeration corresponds to the `WORKSPACE_ROLE` PostgreSQL enum and provides hierarchical access control for workspace members with clearly defined capabilities. oneOf: - description: Full workspace ownership and management capabilities type: string const: owner - description: >- Can manage members, integrations, and settings, but cannot delete workspace or transfer ownership type: string const: admin - description: >- Can edit content and manage files, but cannot manage members or workspace settings type: string const: member - description: Read-only access to workspace content type: string const: guest MemberSortField: description: Fields available for sorting workspace members. oneOf: - description: Sort by display name. type: string const: name - description: Sort by join date. type: string const: date MemberPage: description: |- Generic paginated response wrapper. Provides a consistent structure for all paginated API responses with cursor-based pagination support. When `next_cursor` is present, there are more items to fetch. type: object properties: items: description: Items in this page. type: array items: $ref: '#/components/schemas/Member' nextCursor: description: Cursor to fetch the next page. Present only when more items exist. type: string total: description: Total count of items matching the query (if requested). type: integer format: int64 required: - items ErrorResponse: description: |- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. type: object properties: message: description: User-friendly error message safe for client display type: string name: description: The error name/type identifier type: string resource: description: The resource that the error relates to (optional, set by handler) type: string suggestion: description: Helpful suggestion for resolving the error (optional) type: string validation: description: Validation error details for field-specific errors type: array items: $ref: '#/components/schemas/ValidationErrorDetail' required: - name - message Member: description: Represents a workspace member. type: object properties: avatarUrl: description: Serve path of the member's avatar, when set. type: string createdAt: description: Timestamp when the member joined the workspace. type: string format: date-time displayName: description: Display name of the member, when set. type: string emailAddress: description: Email address of the member. type: string has2fa: description: Whether the member has two-factor authentication enabled. type: boolean memberRole: description: Role of the member in the workspace. allOf: - $ref: '#/components/schemas/WorkspaceRole' username: description: Handle of the member's account. allOf: - $ref: '#/components/schemas/Handle' required: - username - emailAddress - memberRole - has2fa - createdAt ValidationErrorDetail: description: Validation error details for field-specific errors. type: object properties: code: description: Error code for the validation failure type: string field: description: Field name that failed validation type: string message: description: Human-readable error message type: string params: description: Additional parameters related to the validation error type: object additionalProperties: true required: - field - code - message Handle: description: >- Lowercase, dash-separated identifier used in URLs and as account handles. type: string maxLength: 32 minLength: 3 pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$ ````