Get current state of User by id or external ref

1min

GET
https://{domain}/app/api/v2/users/{userId}/state
































Possible States
onboarding:onboarding
active:available
active:busy
active:unavailable
active:allocated
active:deboarding
inactive:inactive
inactive:terminal
Path Parameters
userId
string
*
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Responses
200
Get Current State Response
GetStateResponse
error
Error
request
Request
data
StateData
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/app/api/v2/users/{userId}/state' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/app/api/v2/users/{userId}/state' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
default
// Get Current State Response 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "data": {
    "state": "active:available"
  }
}
// Get Current State Response 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  },
  "data": {
    "state": "active:available"
  }
}
﻿
﻿

Possible States
`onboarding:onboarding`
`active:available`
`active:busy`
`active:unavailable`
`active:allocated`
`active:deboarding`
`inactive:inactive`
`inactive:terminal`

Updated 15 Mar 2024

Did this page help you?

Update a User by id or external ref

Update state of User by id or external ref