# UserStatus object

div
strong
🔨 In Development
 — This section is still being developed and may change.


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.

## Properties

### Identity

**`id`** string required

Unique status identifier. Format: `sts_` followed by alphanumeric characters.

**`name`** string required

Status name (e.g., `Active`, `Inactive`, `InvitationSent`).

**`description`** string | null optional

Human-readable description of the status.

### Scope

**`organization_id`** string required

Reference to the [Organization](/docs/api-reference/objects/organization-object) this status belongs to.

### Status Configuration

**`is_base_status`** boolean required

Whether this is a mandatory base status. Base statuses cannot be deleted. Default: `false`.

**`is_custom`** boolean required

Whether this is a custom organization-specific status. Default: `false`.

**`can_be_deleted`** boolean required

Whether the status can be deleted. Base statuses cannot be deleted. Default: `true`.

### Display & Behavior

**`color`** string | null optional

Hex color code for UI display (e.g., `#4CAF50` for active, `#F44336` for inactive).

**`icon`** string | null optional

Icon identifier for UI display.

**`order`** integer optional

Display order in UI lists. Lower values appear first. Default: `0`.

**`selectable_in_ui`** boolean required

Whether users can manually select this status in the UI. Default: `true`.

### Status State

**`is_active`** boolean required

Whether the status is active and can be assigned. Default: `true`.

### Timestamps

**`created_at`** string required

Timestamp when the status was created. Format: ISO 8601 datetime string.

**`updated_at`** string required

Timestamp when the status was last updated. Format: ISO 8601 datetime string.

## Base Statuses

Every organization is created with these mandatory base statuses:

### Active

User is active and has full access to the organization.

### Inactive

User account is temporarily inactive but not deleted.

### InvitationSent

User has been invited but hasn't accepted yet.

### Deleted

User has been removed from the organization (soft delete).

**Base Status: Active**


```json
{
  "id": "sts_active_abc123",
  "name": "Active",
  "description": "User is active and has full access to the organization",
  "organization_id": "ORG_A1B2C3D4E5F6G7H8",
  "is_base_status": true,
  "is_custom": false,
  "can_be_deleted": false,
  "color": "#4CAF50",
  "icon": "check_circle",
  "order": 1,
  "selectable_in_ui": true,
  "is_active": true,
  "created_at": "2025-01-10T09:00:00Z",
  "updated_at": "2025-01-10T09:00:00Z"
}
```

**Base Status: InvitationSent**


```json
{
  "id": "sts_invitation_def456",
  "name": "InvitationSent",
  "description": "User has been invited but hasn't accepted yet",
  "organization_id": "ORG_A1B2C3D4E5F6G7H8",
  "is_base_status": true,
  "is_custom": false,
  "can_be_deleted": false,
  "color": "#FF9800",
  "icon": "mail_outline",
  "order": 3,
  "selectable_in_ui": false,
  "is_active": true,
  "created_at": "2025-01-10T09:00:00Z",
  "updated_at": "2025-01-10T09:00:00Z"
}
```

**Custom Status: OnBoarding**


```json
{
  "id": "sts_onboarding_ghi789",
  "name": "OnBoarding",
  "description": "User is currently going through onboarding process",
  "organization_id": "ORG_A1B2C3D4E5F6G7H8",
  "is_base_status": false,
  "is_custom": true,
  "can_be_deleted": true,
  "color": "#2196F3",
  "icon": "school",
  "order": 2,
  "selectable_in_ui": true,
  "is_active": true,
  "created_at": "2025-01-12T10:00:00Z",
  "updated_at": "2025-01-12T10:00:00Z"
}
```