Note:New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
HTTP request
GET https://cloudidentity.googleapis.com/v1/{parent=customers/*}/userinvitations
Required. The customer ID of the Google Workspace or Cloud Identity account theUserInvitationresources are associated with.
Query parameters
Parameters
pageSize
integer
Optional. The maximum number ofUserInvitationresources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be set to 200.
pageToken
string
Optional. A page token, received from a previoususerinvitations.listcall. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListBooksmust match the call that provided the page token.
filter
string
Optional. A query string for filteringUserInvitationresults by their current state, in the format:"state=='invited'".
orderBy
string
Optional. The sort order of the list results.
You can sort the results in descending order based on either email or last update timestamp but not both, usingorder_by="email desc". Currently, sorting is supported forupdate_time asc,update_time desc,email asc, andemail desc.
If not specified, results will be returned based onemail ascorder.
The token for the next page. If not empty, indicates that there may be moreUserInvitationresources that match the listing request; this value can be used in a subsequentListUserInvitationsRequestto get continued results with the current list call.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis API endpoint retrieves a list of \u003ccode\u003eUserInvitation\u003c/code\u003e resources associated with a specific Google Workspace or Cloud Identity account, identified by the customer ID.\u003c/p\u003e\n"],["\u003cp\u003eNew consumer accounts or newly-verified domains created within the past 48 hours will not be included in the results returned by this API.\u003c/p\u003e\n"],["\u003cp\u003eThe number of \u003ccode\u003eUserInvitation\u003c/code\u003e resources returned can be controlled using the \u003ccode\u003epageSize\u003c/code\u003e parameter, with a maximum of 200, and the results can be navigated using the \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter the results by their current state, for example, to only display invited users, and you can sort the results by email or last update timestamp, in ascending or descending order.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this API requires specific OAuth scopes, either \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-identity.userinvitations.readonly\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-identity.userinvitations\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: customers.userinvitations.list\n\nRetrieves a list of [UserInvitation](/identity/docs/reference/rest/v1/customers.userinvitations#UserInvitation) resources.\n\n**Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.\n\n### HTTP request\n\n`GET https://cloudidentity.googleapis.com/v1/{parent=customers/*}/userinvitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for [UserInvitation](/identity/docs/reference/rest/v1/customers.userinvitations#UserInvitation) listing request.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-identity.userinvitations.readonly`\n- `https://www.googleapis.com/auth/cloud-identity.userinvitations`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
