> ## Documentation Index > Fetch the complete documentation index at: https://docs.gorules.io/llms.txt > Use this file to discover all available pages before exploring further. # List invitations > Retrieve a paginated list of invitations for the organisation with optional filtering by search term and status. ## OpenAPI ````yaml /openapi/brms.json get /api/invitations openapi: 3.0.3 info: title: GoRules BRMS version: local servers: [] security: [] tags: - name: AI description: >- AI-powered assistant for interactive conversations and decision logic generation - name: Audit log description: Track and export organisation activity logs for compliance and monitoring - name: Branches description: >- Manage feature branches for collaborative decision development with commits and merging - name: Change requests description: Review and approve changes before merging or deploying to environments - name: Cloud description: Cloud-specific endpoints for organisation and client management - name: Decision description: Evaluate and simulate decision graphs with trace and performance data - name: Deployment workflows description: Manage deployment workflow runs and job approvals - name: Deployments description: Configure cloud storage providers for release deployments - name: Document description: Manage decision documents, versions, and file operations within projects - name: Environment description: >- Configure deployment environments with approval workflows and access tokens - name: Group description: Manage permission groups for project-level access control - name: Infrastructure description: Health check and infrastructure status endpoints - name: Integration description: Configure external integrations for HTTP requests and data sources - name: Invitation description: Manage organisation invitations for new members - name: Member description: Manage project membership and group assignments - name: Organisation description: Manage organisation settings, preferences, and licensing - name: Personal access token description: Create and manage personal access tokens for API authentication - name: Profile description: Manage current user profile settings - name: Project description: Create and manage projects with approval workflows - name: Release description: >- Package, version, and deploy decision documents. Learn more about [Releases](https://gorules.io/developers/brms/multi-environment) - name: Roles description: Define custom roles with permissions for organisation-wide access control - name: Security description: Manage project access tokens for API authentication - name: Templates description: Browse and apply project templates for quick onboarding - name: Test events description: Manage test events for decision evaluation and testing - name: User description: Manage organisation users, invitations, and service accounts paths: /api/invitations: get: tags: - Invitation summary: List invitations description: >- Retrieve a paginated list of invitations for the organisation with optional filtering by search term and status. operationId: listInvitations parameters: - schema: type: string in: query name: search description: Search term to filter invitations by email - schema: type: string enum: - pending - accepted in: query name: status description: Filter invitations by status - schema: type: number default: 1 in: query name: page description: Current page - schema: type: number default: 10 in: query name: perPage description: Number of items per page responses: '200': description: Paginated list of invitations content: application/json: schema: type: object properties: results: type: array items: type: object properties: id: type: string format: uuid description: Unique identifier of the invitation email: type: string format: email description: Email address the invitation was sent to expiresAt: type: string nullable: true description: Expiration date of the invitation createdAt: type: string description: Timestamp when the invitation was created acceptedAt: type: string nullable: true description: Timestamp when the invitation was accepted status: type: string enum: - pending - accepted description: Current status of the invitation createdBy: type: object nullable: true properties: id: type: string format: uuid description: Unique identifier of the user email: type: string format: email description: Email address of the user firstName: type: string nullable: true description: First name of the user lastName: type: string nullable: true description: Last name of the user type: type: string enum: - invited - member - author - admin - owner description: Type of user (e.g., admin, member) status: type: string enum: - active - disabled - locked description: Current status of the user required: - id - email - firstName - lastName - type - status description: User who created the invitation user: type: object nullable: true properties: id: type: string format: uuid description: Unique identifier of the user email: type: string format: email description: Email address of the user firstName: type: string nullable: true description: First name of the user lastName: type: string nullable: true description: Last name of the user type: type: string enum: - invited - member - author - admin - owner description: Type of user (e.g., admin, member) status: type: string enum: - active - disabled - locked description: Current status of the user required: - id - email - firstName - lastName - type - status description: User the invitation is for organisation: type: object nullable: true properties: id: type: string format: uuid description: Unique identifier of the organisation name: type: string description: Name of the organisation required: - id - name description: Organisation the invitation belongs to required: - id - email - expiresAt - createdAt - acceptedAt - status description: List of invitations paginate: type: object properties: current: type: number description: Current page number from: type: number description: Starting record number on the current page to: type: number description: Ending record number on the current page total: type: number description: Total number of records pageSize: type: number description: Number of records per page required: - current - from - to - total - pageSize description: Pagination metadata required: - results - paginate description: Paginated list of invitations security: - personalAccessToken: [] - internalAuth: [] components: securitySchemes: personalAccessToken: type: http scheme: bearer description: Personal access token is obtained through your profile internalAuth: type: http scheme: internal description: Cannot be used directly ````