Get user by name
Retrieve user information by searching for their name.
This endpoint searches for a user by name and returns their details if found. The name parameter is matched against the user's stored name field. Use this when you have a user's name but not their UUID.
Context: - Searches by exact name match (case-sensitive) - Returns first matching user if multiple users have same name - Does not search across first_name and last_name separately - User must exist in database - Returns 404 with clear message if user not found
Behavior: 1. Searches database for user with matching name 2. Returns first matching user if found 3. Returns 404 error with descriptive message if no match Use Cases: - Lookup user when only name is known - Verify user exists by name before operations - User search in admin interfaces - Integration with external systems using names instead of UUIDs
Recommended Alternative: For more reliable lookups, use GET /admin/users/{user_id} with UUID
Related Endpoints: - GET /admin/users/{user_id} - Get user by UUID (preferred for reliability) - GET /admin/users - List all users (for browsing) - GET /admin/organizations/{id}/users - List users in organization
Header Parameters
Path Parameters
User's name to search for. Case-sensitive, exact match required. May match against first name, last name, or full name depending on implementation.
Response
Response Attributes
Timestamp when user was created. Format: ISO 8601 UTC (e.g., '2025-01-23T15:30:00Z').
User's email address. Must be unique within organization. Used for login, authentication, and notifications. Synchronized with authentication system. Can be updated after user creation.
User's first name. Used in UI displays, emails, and user identification. Can be updated after user creation.
Unique identifier for the user. Format: UUID v4. Synchronized with authentication system user ID.
User's last name. Used in UI displays, emails, and user identification. Can be updated after user creation.
Identifier of the user or system that last modified this user. Can be user UUID or system identifier (e.g., 'system', 'admin'). Used for audit trail and change attribution.
UUID of the organization this user belongs to. Users are scoped to a single organization (no cross-org access). Organization must exist and determines user's data access scope.
User's role within the organization. Determines permission level. Valid values: 'org_admin', 'backoffice', 'app_user', 'integration'.
Role permissions:
- 'org_admin': Full organization access and user management
- 'backoffice': Super admin with platform-level access
- 'app_user': Regular user who can create and manage own flows and executions
- 'integration': Service account for integrations and automated workflows
User's current account status. Valid values: 'active', 'inactive'.
'active': User can log in and access the system. 'inactive': User cannot log in; account is disabled. Note: Even active users must accept email invitation to log in initially.
Timestamp when user was last modified. Updated automatically on any field change. Format: ISO 8601 UTC (e.g., '2025-01-24T10:45:00Z'). Used for change tracking and audit logs.
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.
Show child attributes
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.
Show child attributes
Response Attributes
Show child attributes
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.