Actions118
- Mailbox Management Actions
- Mailboxes Actions
- Mailboxes > Accesses > Devices Actions
- Mailboxes > Accesses > Invitations Actions
- Mailboxes > Accesses > Webmail Actions
- List User Access And Invitations
- Create Webmail Access
- Set The Primary Mailbox For The Authenticated User
- List Users Having Access
- List Of User Accesses For The Current User
- List Of User Accesses For A Account And A User
- Update Webmail Access
- Delete Webmail Access
- Delete Access To A Mailbox For The Current User
- Mailboxes > Aliases Actions
- Mailboxes > Auto Reply Actions
- Mailboxes > Folders Actions
- Mailboxes > Forwarding Actions
- Mailboxes > Sieve Filters Actions
- Mailboxes > Signatures Actions
- Mailboxes > Users Actions
- Mailing List Actions
- Mailing List > Subscribers Actions
- Service Mail > Auto Reply Actions
- Service Mail > Bimi Actions
- Service Mail > Filters Models Actions
- Service Mail > Preferences Actions
- Service Mail > Redirections Actions
- Service Mail > Redirections > Target Actions
- Service Mail > Signatures Templates Actions
Mailboxes > Accesses > Webmail → List User Access And Invitations
AI-generatedSummary
List user access and invitation records for a mailbox.
Inputs
- authentication — Authentication method to use (OAuth2 or API Key).
- path_service_mail (required) — The unique identifier (ID) of the mail hosting to request.
- path_mailbox_name (required) — The username (part before @) of the email address whose accesses and invitations to list.
- query_with — Optional parameter to load additional data about related resources.
- query_search — Optional parameter for search criteria.
- query_return — Optional mode; if set to 'total', response body contains a count instead of items.
- query_page — Optional page number for pagination.
- query_per_page — Optional number of items per page for pagination.
- query_order_by — Optional field used for sorting results.
- query_order — Optional default sort order (asc or desc).
- query_order_for — Optional JSON specifying sorting order for a field; defaults to 'order'.
- returnAll — Whether to return all results; defaults to true.
- limit — Maximum number of results to return; default 50, range 1-500.
- returnFullResponse — Whether to return the full response payload; defaults to false.
Output shape
a collection of user access and invitation entries
Pagination parameters (
page,per_page) can limit results; ifquery_returnis set tototal, the response body contains a count instead of items; otherwise items are returned; additional data may be included viaquery_with.
Examples
Example 1: Retrieve accesses for a specific mailbox using OAuth2
authentication=oauth2 path_service_mail=123 path_mailbox_name=john.doe limit=50 returnAll=true
Example 2: Count total accesses for a mailbox using API Key
authentication=apiKey path_service_mail=456 path_mailbox_name=admin query_return=total
Example 3: List accesses with extra related data and pagination
authentication=oauth2 path_service_mail=789 path_mailbox_name=mary query_with=user query_page=1 query_per_page=20 query_order_by=date query_order=desc