Skip to main content

UserInvitationDto

A network user invitation, as seen by an API client. The opaque link token, inviter identity, and persistence internals (version, free-form info) are intentionally not exposed --- the link is returned separately as invite_url on create.

idstring

Unique id of the invitation

Example: 7Hb2Kp9QvL3mNx0R8tZ4
network_idstring

Id of the network the recipient is invited to join

Example: 9Kp3Lm2QvX7nRt0B8wZ5
emailstring

Email address the invitation was sent to

Example: member@example.com
first_namestring

Recipient's first name

Example: Jordan
last_namestring

Recipient's last name

Example: Lee
rolestring

Network membership role to grant on acceptance

Possible values: [admin, viewer]

Example: viewer
statusstring

Invitation lifecycle status

Possible values: [pending, accepted, expired, revoked]

Example: pending
expires_atdate-time

When the invitation expires and can no longer be accepted

Example: 2026-01-15T09:30:00Z
created_atdate-time

When the invitation was created

Example: 2026-01-15T09:30:00Z
updated_atdate-time

When the invitation was last updated

Example: 2026-01-15T09:30:00Z
UserInvitationDto
{
"id": "7Hb2Kp9QvL3mNx0R8tZ4",
"network_id": "9Kp3Lm2QvX7nRt0B8wZ5",
"email": "member@example.com",
"first_name": "Jordan",
"last_name": "Lee",
"role": "viewer",
"status": "pending",
"expires_at": "2026-01-15T09:30:00Z",
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z"
}