WorkspaceInvitationResponseDto

Example

JSON

{
  "id": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "name": "string",
  "role_id": "string",
  "role_name": "string",
  "node_id": "string",
  "node_name": "string",
  "has_initial_assignment": false,
  "status": "pending",
  "expires_at": "2026-04-20T12:00:00.000Z",
  "invited_by": "string",
  "created_at": "2026-04-20T12:00:00.000Z"
}

Properties

14 properties 10 required

id string Required

email string Required

first_name string Required

last_name string Required

name string Required

role_id string Optional

nullable

role_name string Optional

nullable

node_id string Optional

nullable

node_name string Optional

nullable

has_initial_assignment boolean Required

True when the invitation carries a starting role at a location, so accepting it grants access rather than only creating the identity.

status enum Required

Enumpendingacceptedrevokedexpired

expires_at string Required

format: date-time

invited_by string Required

The platform user who sent the invitation, or null when an API key created it or the inviter's user is gone

nullable

created_at string Required

format: date-time

Was this page helpful?

Tell us how we can improve this guide.