Ampersand · Schema
Invite
Invite schema from Ampersand API
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks
Properties
| Name | Type | Description |
|---|---|---|
| id | string | The invite ID. |
| invitedEmail | string | The email address of the person invited. |
| parentType | string | The type of entity that the person is invited to. |
| parentId | string | The ID of the parent (e.g. org ID). |
| status | string | The status of the invite. |
| createTime | string | The time the invite was created. |
| updateTime | string | The time the invite was updated. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-invite-schema.json",
"title": "Invite",
"description": "Invite schema from Ampersand API",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The invite ID."
},
"invitedEmail": {
"type": "string",
"description": "The email address of the person invited."
},
"parentType": {
"type": "string",
"enum": [
"org"
],
"description": "The type of entity that the person is invited to."
},
"parentId": {
"type": "string",
"description": "The ID of the parent (e.g. org ID)."
},
"status": {
"type": "string",
"description": "The status of the invite.",
"enum": [
"pending",
"accepted",
"revoked",
"expired"
]
},
"createTime": {
"type": "string",
"description": "The time the invite was created.",
"format": "date-time"
},
"updateTime": {
"type": "string",
"description": "The time the invite was updated.",
"format": "date-time"
}
},
"required": [
"id",
"invitedEmail",
"createTime",
"parentId",
"parentType",
"status"
]
}