Memos unofficial
GET/api/v1/spaces/{space}/invitations/{invitation}

Get a space invitation

Retrieves a pending invitation to join a space. Use space and invitation to identify the invitation whose details you need, including its invitee and assigned role.

2 parameters
spacestringrequired
The identifier of the space containing the invitation.
invitationstringrequired
The identifier of the pending invitation to retrieve.

2 status codes
200Returns the pending invitation, including its resource name, invitee, role, and space.
namestringoptional
The resource name. Format: spaces/{space}/invitations/{username}.
inviteestringrequired
Required. The invited user. Format: users/{username}.
rolestringrequired
Required. The role the user will receive after accepting the invitation.
Allowed:ROLE_UNSPECIFIEDADMINUSER
spaceobjectoptional
Output only. The Space the user is invited to. This lets an invitee understand the invitation without granting membership-based GetSpace access.
defaultDefault error response
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

The space path parameter must identify the space containing the invitation, and the invitation path parameter must identify a pending invitation in that space. The invitation's invitee uses the users/{username} resource format, and role is one of ROLE_UNSPECIFIED, ADMIN, or USER.