Return details on a pending team invitation.

Return details on a pending team invitation.

Path Parameters

inviteCode string required

The invite code provided to the user.

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

invitation object

Represents an invitation to a team. This has limited information since it is used only for sending and verifying details of an invitation.

inviteCode string

The invitation code for this invite.

sender string

The sender of the invitation.

email string

The email address that the invitation was sent to.

teamName string

The human-readable name of the team that the invitation is for.

role object

The team role that this invitation represents.

isAdmin boolean

True if the user is an admin for the team.

created date-time

When this invitation was sent.

{
  "invitation": {
    "inviteCode": "string",
    "sender": "string",
    "email": "string",
    "teamName": "string",
    "role": {
      "isAdmin": true
    },
    "created": "2024-03-07T22:56:08.453Z"
  }
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

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.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...