# Get User

<!-- meta: type=get-user; location=Users; category=Step (action); platforms=Joomla and WordPress (where applicable) -->

## Overview

Get User is a **Step (action)** in **Users**. Retrieves a Joomla user by User ID, email, or username.

When the flow reaches this step, JOrchestrator executes **Get User** against your linked site or an external integration, using the field values you set on **General** and **Design**. Downstream steps can read the output payload fields defined for this node.

## Why use this node

Get User is a **action step** in the **Users** group. Action steps run in the middle or end of a flow. They perform work on your CMS, call external services, or transform data for the next step.

Typical reasons teams add **Get User** to a flow:

- Get User on your linked Joomla site when the flow reaches this step
- Get user based on webhook, schedule, or CMS event data
- Integrate Users operations with messaging, AI, or database steps in one canvas

## Example workflows

Common patterns on the canvas:

1. **Trigger or Webhook** → upstream steps → **Get User** → **Send Email** or CMS update
2. **Scheduled trigger** → **Get User** → **Debug** (while testing) → production action

## How to set it up

Returns profile fields and group ids in the payload.

## Good to know

Password hash is never returned — only safe profile data for downstream steps.

## Properties panel

The designer shows these tabs for this node:

| Tab | Purpose |
|-----|---------|
| **Info** | Plain-language description and output payload fields for downstream steps |
| **General** | Canvas label and read-only node ID |
| **AI** | Optional assistant to help draft settings from plain language |
| **Design** | Node-specific configuration fields |

### System (automatic — not edited by the user)

These fields are managed by the designer or runtime — you do not type into them directly:

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `_nodeId` | Node ID | `node-id` | No | — | — |
| `_payloadFields` | Available Fields | `payload-panel` | No | — | — |

### User-configured — General tab

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `label` | Label | `text` | No | — | Node label |

### User-configured — Design tab

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `email` | Email | `email` | No | — | user@example.com or {{placeholder}} |
| `username` | Username | `text` | No | — | Login name or {{placeholder}} |

### CMS-backed or hybrid (loaded from the linked site at design time)

These fields can pull live options or values from the Joomla/WordPress site linked to the flow:

| Property key | Label | Type | Required | Visible when | Notes |
|--------------|-------|------|----------|--------------|-------|
| `userId` | User ID | `email-recipient` | No | — | Numeric id, {{placeholder}}, or select Joomla user… Provide at least one way to find the user (they work as OR — any filled field can match):

• User ID — numeric id, pick from the your site user list, or {{placeholder}}
• Email — account email address or {{placeholder}}
• Username — login name or {{placeholder}}

If you fill more than one, your site tries them in order until a user is found. Password is never returned. Value kind: `userId` |

### CMS site configuration (not on this node's properties panel)

Credentials, API keys, mailers, SMTP, and integration defaults are configured in the CMS plugin under **Node Configuration**, not per step on this node. Link the flow to a domain before testing CMS-backed fields.

## Output payload fields

After this step runs, later nodes can reference these fields using placeholders such as
`{{get_user.id}}`.

| Field key | Type | Description |
|-----------|------|-------------|
| `id` | string | Primary record identifier. |
| `username` | string | Text value from this node's output. |
| `email` | string | Text value from this node's output. |
| `name` | string | Display name of the record. |
| `block` | number | Whether the user account is blocked. |
| `sendEmail` | number | Numeric value from this node's output. |
| `registerDate` | string | Account registration date/time. |
| `lastvisitDate` | string | Last site visit date/time. |
| `activation` | string | Account activation token or status. |
| `groups` | array | User group IDs assigned to the account. |
| `success` | boolean | Whether the operation completed successfully. |

## Related nodes

Other steps in the same area of the palette:

- **Block User** (`block-user`) — Users
- **Create User** (`create-user`) — Users
- **Create User** (`wp-create-user`) — Users
- **Delete User** (`delete-user`) — Users
- **Delete User** (`wp-delete-user`) — Users