Invitation

object

idrequired: Id
Opaque record id.
emailrequired: string or null
phonerequired: string or null
rolerequired: object or null
role.idrequired: Id
Opaque record id.
role.namerequired: string
branchrequired: object or null
branch.idrequired: Id
Opaque record id.
branch.namerequired: string
reports_torequired: object or null
reports_to.idrequired: Id
Opaque record id.
reports_to.namerequired: string
invited_byrequired: object or null
invited_by.idrequired: Id
Opaque record id.
invited_by.namerequired: string
expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
expiredrequired: boolean

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "email": "string",
  "phone": "string",
  "role": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "branch": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "reports_to": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "invited_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "expires_at": "2026-10-06T05:30:00.000Z",
  "created_at": "2026-10-06T05:30:00.000Z",
  "expired": true
}