Invitations
List Invitations
List invitations for the current business with filtering and pagination.
Query parameters:
- status__eq: Filter by status (pending, accepted, rejected, expired, revoked)
- business_id__eq: Filter by business ID (alias for inviter_business_id__eq)
- inviter_business_id__eq: Filter by inviter business ID
- invitee_user_id__eq: Filter by invitee user ID
- created_at__gte: Filter by created date (greater than or equal)
- created_at__lte: Filter by created date (less than or equal)
- expires_at__gte: Filter by expiry date (greater than or equal)
- expires_at__lte: Filter by expiry date (less than or equal)
- sort: Sort fields (e.g., "-created_at" for descending, "status" for ascending)
- page: Page number (default: 1)
- limit: Items per page (default: 10, max: 100)
Example: /api/v1/invitations?status__eq=pending&business_id__eq=123&sort=-created_at&page=1&limit=10
Note: By default, invitations are filtered to the current authenticated business. You can override this by specifying business_id__eq or inviter_business_id__eq.
get/api/v1/invitations
Query parameters
pageinteger
limitinteger
Response
Successful Response
Changes
No recorded changes to this endpoint across all 1 revision of this API.