Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
SDS Service
App
Vault
Data
File Management Service
Folders
Files
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
IOT Device
Geofence
MTS Subscription
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Notification Service
App Notification
Filter
Event
Change Log
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
Address Service
Address Config
Address
User FPA
Users
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Batch Order
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginWorkflow
Rules
Get Entity Status
DLQ Service
Query & Listing
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Scheduler Service
Scheduler Service
Docs powered by Archbee
User FPA
Users

Get current state of User by id or external ref

1min
GET
Possible States
onboarding:onboarding
active:available
active:busy
active:unavailable
active:allocated
active:deboarding
inactive:inactive
inactive:terminal
PATH PARAMETERS
userId
string
*
User ID.
HEADER PARAMETERS
X-COREOS-TID
string
*
Example: os1devs
Tenant ID
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
RESPONSES
200
Default State Get Response
GetStateResponse
error
Error
Error Information
request
Request
data
StateData
default
Default Error Response
DefaultResponse
error
Error
Error Information
request
Request
data
object
Example: [object Object]




Updated 03 Aug 2023
Did this page help you?
PREVIOUS
Update a User by id or external ref
NEXT
Update state of User by id or external ref
Docs powered by Archbee