Skip to content
Hayonix

API reference · Schema

Invitation

  • objectstringrequired

    Always `invitation`: the type of this object

    One ofinvitation

  • idstringrequired

    Unique ID (`inv_…`)

    ID with prefix inv_

  • org_idstringrequired

    Organization it belongs to

    ID with prefix org_

  • emailstringrequired

    Email address the invitation was sent to

  • rolestring | nullrequired

    Role the invitee gets on accepting; null when none was recorded

    One ofowneradmindeveloperbillingviewer

  • statusstringrequired

    `pending` (can still be accepted until `expires_at`), `accepted`, `rejected` or `canceled`

  • expires_atstring (date-time)required

    When it expires (null: never) (ISO 8601, UTC)

  • inviter_user_idstringrequired

    ID of the inviter user

  • inviterobject | nullrequired

    Who sent the invitation

    Show 3 fields of inviter
    • objectstringrequired

      Always `person`

      One ofperson

    • idstringrequired

      The person’s user ID (`usr_…`)

    • namestring | nullrequired

      Their name as they set it; null when they are no longer a member of the organization

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

Example
{
  "object": "invitation",
  "id": "inv_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "email": "string",
  "role": "owner",
  "status": "pending",
  "expires_at": "2026-01-01T00:00:00.000Z",
  "inviter_user_id": "string",
  "inviter": {
    "object": "person",
    "id": "string",
    "name": "string"
  },
  "created_at": "2026-01-01T00:00:00.000Z"
}

Used by