The UserStatus object defines the status states that users can have within an organization. Each organization has a set of base statuses and can define custom statuses for workflow management.
id string required
Unique status identifier. Format: status_ followed by alphanumeric characters.
name string required
Status name (e.g., Active, Inactive, InvitationSent).
description string | null optional
Human-readable description of the status.
organization_id string required
Reference to the Organization this status belongs to.
is_base_status boolean required
Whether this is a mandatory base status. Base statuses cannot be deleted. Default: false.
color string | null optional
Hex color code for UI display (e.g., #4CAF50 for active, #F44336 for inactive).
order integer required
Display order in UI lists. Lower values appear first. Default: 0.
Every organization is created with these mandatory base statuses:
User is active and has full access to the organization.
User account is temporarily inactive but not deleted.
User has been invited but hasn't accepted yet.
User has been removed from the organization (soft delete).