List user invitations

v1
mail
get
/1/mail_hostings/{mail_hosting_id}/invitations

Returns a variety of information about one or more user invitations for a given mailbox.

Path parameters

mail_hosting_id
requiredinteger

The unique identifier (ID) of the mail hosting to request.

Examples:86297

Query parameters

withstring
Possible values:mailbox
Examples:mailbox

Response Body

application/json
resultrequiredstring
Possible values:successerrorasynchronous

Result of the HTTP request

Examples:success
dataarrayofWorkspaceInvitation

Example request

                <?php
use GuzzleHttp\Client;

$client = new Client();
$headers = [
	'Authorization' => 'Bearer YOUR-TOKEN-HERE',
	'Content-Type' => 'application/json'
];

$request = new Request('GET', 'https://api.infomaniak.com/1/mail_hostings/{mail_hosting_id}/invitations', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
            

Example response

application/json
                
                    
{
"result":"success",
"data":[
{
"short_url":"example",
"key":"example",
"sent_to":"schulist.brando@braun.org",
"permissions":[
{
"can_manage_filters":true,
"can_manage_security":true,
"can_manage_aliases":false,
"can_manage_redirections":true,
"can_manage_signatures":true,
"can_manage_auto_reply":true,
"can_change_password":false,
"can_configure_mail_folders":false
}
],
"expired_at":1732161605,
"is_valid":false,
"is_used":false
}
]
}