--- title: "List mailboxes" method: GET path: "/1/mail_hostings/{mail_hosting_id}/mailboxes" tags: ["Mailbox management"] --- # List mailboxes `GET /1/mail_hostings/{mail_hosting_id}/mailboxes` This endpoint allows you to retrieve all the mailboxes for a given mail hosting. ## Path parameters - `mail_hosting_id` integer, required ## Query parameters - `search` string - `filter_by` string - `with` string - `filter` object - `has_alias` boolean - `has_anti_spam` boolean - `has_redirection` boolean - `has_responder` boolean - `is_using_imap` boolean - `is_using_pop3` boolean - `last_login_at` integer — Timestamp `{name}` has been logged - `return` 'total' - `limit` integer - `skip` integer - `page` integer - `per_page` integer - `order_by` union - string - string[] - `order` 'asc' | 'desc' - `order_for` object ## Response `200` OK - object - `result` 'success' | 'error' | 'asynchronous', required — Result of the HTTP request - `data` 93e74a89Mailbox[] - `users` 93e74a89UserV2[], required - `id` integer, required — Unique identifier of the resource `UserV2` - `display_name` string, required — Display name - `first_name` string, required — First name - `last_name` string, required — Last name - `email` string, required — Email - `avatar` string, required — Avatar - `is_sso` boolean, required - `permissions_binary` integer - `permissions` 93e74a89Permissiononmailbox - `can_manage_filters` boolean, required - `can_manage_security` boolean, required - `can_manage_aliases` boolean, required - `can_manage_redirections` boolean, required - `can_manage_signatures` boolean, required - `can_manage_auto_reply` boolean, required - `can_change_password` boolean, required - `can_configure_mail_folders` boolean, required - `can_send_emails` boolean, required - `can_restore_emails` boolean, required - `can_manage_rules` boolean, required - `can_access_logs` boolean, required - `mailbox_name` string, required - `mailbox` string, required - `mailbox_idn` string, required - `note` string, nullable, required - `type` integer, nullable, required - `count_signatures` integer - `count_invitations` integer - `count_users` integer - `is_limited` boolean, required - `is_free_mail` boolean, required - `has_auto_responder` boolean - `auto_responder` object - `is_active` boolean, required — Is the resource `Mailbox` active ? - `has_redirection` boolean - `redirection` string[] - `aliases` string[] — List of aliases - `full_aliases` string[] - `created_at` integer — Timestamp `Mailbox` has been created - `password_last_changed_at` integer - `size` integer — Display the size of the mailbox, should be displayed when with=size or when with=size_refresh(this activate the recalculation, forced when this was more then 3 months - `size_checked_at` integer — This indicates the last time the size was calculated by the system. Should be display with the argument with=size_refresh or with=size - `imap_last_login_at` integer - `pop3_last_login_at` integer - `operation_in_progress` boolean - `teams` 93e74a89Team[], nullable - `id` integer, required — Unique identifier of the resource `Team` - `name` string, required — Name of the resource `Team` - `color_id` integer, required — Unique identifier of the `color` of the resource `Team` - `owned_by_id` integer, nullable, required — Unique identifier of the `user` that owned the resource `Team` - `created_by_id` integer, nullable, required — Unique identifier of the `user` that created the resource `Team` - `created_at` integer, required — Timestamp `Team` has been created - `updated_at` integer, required — Timestamp `Team` has been updated - `created_by` 93e74a89User - `id` integer, required — Unique identifier of the resource `User` - `email` string, required — Email - `firstname` string, required - `lastname` string, required - `avatarUrl` string, required - `owned_by` 93e74a89User - `id` integer, required — Unique identifier of the resource `User` - `email` string, required — Email - `firstname` string, required - `lastname` string, required - `avatarUrl` string, required - `user_count` integer — User count related to the resource `Team` - `product_count` integer — Product count related to the resource `Team` - `product_by_service_count` integer — Product by service count related to the resource `Team` - `has_move_spam` boolean - `authorized_senders` 93e74a89Listedsenders[] - `email` string, required — Email - `locked` string, required - `blocked_senders` 93e74a89Listedsenders[] - `email` string, required — Email - `locked` string, required - `has_dkim_signature` boolean - `is_dkim_updatable` boolean - `has_mail_filtering` boolean - `mail_filtering_folder_commercials` string - `mail_filtering_folder_social_networks` string - `is_auth` boolean - `is_removable` boolean - `permissions` object - `has_technical_right` boolean, required - `can_manage_aliases` boolean, required - `can_manage_redirections` boolean, required - `can_manage_filters` boolean, required - `can_manage_security` boolean, required - `can_manage_signatures` boolean, required - `can_manage_auto_reply` boolean, required - `can_change_password` boolean, required - `can_configure_mail_folders` boolean, required - `can_send_emails` boolean, required - `can_restore_emails` boolean, required - `can_manage_rules` boolean, required - `can_access_logs` boolean, required - `is_linked_to_user` string - `mailbox_id` integer - `is_used_for_account` string, required - `account_user` 93e74a89UserV2 - `id` integer, required — Unique identifier of the resource `UserV2` - `display_name` string, required — Display name - `first_name` string, required — First name - `last_name` string, required — Last name - `email` string, required — Email - `avatar` string, required — Avatar - `is_sso` boolean, required - `permissions_binary` integer - `permissions` 93e74a89Permissiononmailbox - `can_manage_filters` boolean, required - `can_manage_security` boolean, required - `can_manage_aliases` boolean, required - `can_manage_redirections` boolean, required - `can_manage_signatures` boolean, required - `can_manage_auto_reply` boolean, required - `can_change_password` boolean, required - `can_configure_mail_folders` boolean, required - `can_send_emails` boolean, required - `can_restore_emails` boolean, required - `can_manage_rules` boolean, required - `can_access_logs` boolean, required - `external_mail_flag_enabled` string, nullable — Indicates if the mailbox has the option to mark mail from external provider activated - `smtpban_bounce` string - `smtpban_auth` string - `smtpban_url` string, nullable - `private` object, required - `count_devices` integer - `has_legacy_device` boolean - `has_multi_password` boolean - `access_rights` object - `can_create_webmail_access` boolean, required - `can_create_device` boolean, required - `can_delete_device_legacy` boolean, required - `can_regenerate_device_legacy` boolean, required - `can_ask_reset_password` boolean, required - `can_create_webmail_access_for_login` boolean - `can_list_users` boolean, required - `total` integer — Total number of items Added when using query parameter `page` - `page` integer — Number of the current page Added when using query parameter `page` - `pages` integer — Total number of pages Added when using query parameter `page` - `items_per_page` integer — Number of items per page Added when using query parameter `page` ## Other responses - `404` — Not Found --- [API](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools.md) · [All operations](https://skmtc.dev/infomaniak/apis/api-reference-developer-tools/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/infomaniak/api-reference-developer-tools/revisions/667aae28fec6/schema)