The invite object

⚠️

Preview — this feature is being built; the design below is the spec.

The invite object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "invite_01JCD3F5H7K9M1P3R5T7",
  "type": "invite",
  "email": "sam@example.com",
  "role": "developer",
  "workspaces": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "role": "workspace_developer"
    }
  ],
  "status": "pending",
  "invited_by": {
    "id": "user_01J9X8Z6B4D2F0H8K6M4",
    "email": "ops@example.com"
  },
  "created_at": "2026-11-05T10:00:00Z",
  "expires_at": "2026-11-12T10:00:00Z",
  "accepted_at": null
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `invite`.
`email`	string	Email address.
`role`	string	Role name.
`workspaces`	array	Nested detail; see the endpoint pages below.
`status`	string	`pending`, `accepted`, `expired` or `canceled`.
`invited_by`	object	Nested detail; see the endpoint pages below.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).
`expires_at`	string	Seven days after creation or the latest resend.
`accepted_at`	string or null	See the endpoint pages below.

Returned by

inference_hook legal_hold

Was this page helpful?