Skip to main content
GET
/
orgs
/
{orgId}
/
invites
/
{inviteId}
Get an invite
curl --request GET \
  --url https://api.withampersand.com/v1/orgs/{orgId}/invites/{inviteId} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "<string>",
  "invitedEmail": "<string>",
  "parentId": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
orgId
string
required

ID of the organization.

​
inviteId
string
required

Response

Invite

​
id
string
required

The invite ID.

​
invitedEmail
string
required

The email address of the person invited.

​
parentType
enum<string>
required

The type of entity that the person is invited to.

Available options:
org
​
parentId
string
required

The ID of the parent (e.g. org ID).

​
status
enum<string>
required

The status of the invite.

Available options:
pending,
accepted,
revoked,
expired
​
createTime
string<date-time>
required

The time the invite was created.

​
updateTime
string<date-time>

The time the invite was updated.