> ## 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 invitations > Returns a paginated list of workspace invitations with their current status. ## OpenAPI ````yaml /api-reference/openapi.json get /workspaces/{workspaceSlug}/invites/ 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}/invites/: get: tags: - Invites summary: List invitations description: >- Returns a paginated list of workspace invitations with their current 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: 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 invited role. schema: $ref: '#/components/schemas/WorkspaceRole' description: Filter by invited role. style: form - in: query name: sortBy description: Sort by field. schema: $ref: '#/components/schemas/InviteSortField' 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/InvitePage' '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' 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 InviteSortField: description: Fields available for sorting workspace invites. oneOf: - description: Sort by invitee email. type: string const: email - description: Sort by creation date. type: string const: date InvitePage: 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/Invite' 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 Invite: description: >- Workspace invite with complete information. This response includes all the essential information about an invitation, including the unique invite ID that can be used to track or cancel the invitation later. type: object properties: createdAt: description: When the invitation was created. type: string format: date-time expiresAt: description: When the invitation expires. type: string format: date-time inviteId: description: Unique identifier of the invitation. type: string format: uuid inviteStatus: description: Current status of the invitation. allOf: - $ref: '#/components/schemas/InviteStatus' inviteToken: description: >- Invite token (only included for open invitations without invitee_email). type: string invitedRole: description: Role the invitee will have if they accept. allOf: - $ref: '#/components/schemas/WorkspaceRole' inviteeEmail: description: Email address of the invitee (omitted for open invite codes). type: string updatedAt: description: When the invitation was last updated. type: string format: date-time workspaceSlug: description: Handle of the workspace the invitation is for. allOf: - $ref: '#/components/schemas/Handle' required: - inviteId - workspaceSlug - invitedRole - inviteStatus - expiresAt - createdAt - updatedAt 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 InviteStatus: description: >- Defines the current status of a workspace invitation. This enumeration corresponds to the `INVITE_STATUS` PostgreSQL enum and is used to track the lifecycle of workspace invitations from creation to resolution. oneOf: - description: Invitation has been sent and is awaiting a response from the invitee type: string const: pending - description: >- Invitation has been accepted and the member has been added to the workspace type: string const: accepted - description: Invitation was declined by the invitee type: string const: declined - description: Invitation was canceled by the person who sent it type: string const: canceled - description: Invitation expired due to timeout (automatic system action) type: string const: expired - description: Invitation was revoked by a workspace administrator type: string const: revoked 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]+)*$ ````