InviteUserResponse

Fields

6 fields

email · required

string

email_sent

boolean

expires_at · required

string (date-time)

id · required

string (uuid)

invitation_link · required

string

role · required

UserRole

Raw schema (JSON)

{
  "properties": {
    "email": {
      "title": "Email",
      "type": "string"
    },
    "email_sent": {
      "default": false,
      "title": "Email Sent",
      "type": "boolean"
    },
    "expires_at": {
      "format": "date-time",
      "title": "Expires At",
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "invitation_link": {
      "title": "Invitation Link",
      "type": "string"
    },
    "role": {
      "$ref": "#/components/schemas/UserRole"
    }
  },
  "required": [
    "id",
    "email",
    "role",
    "expires_at",
    "invitation_link"
  ],
  "title": "InviteUserResponse",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/users/invitations/{invitation_id}/resend — Resend Invitation
• POST /api/v1/users/invite — Invite User

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON