Get a User by id or external ref

1min
GET
https://{domain}/app/api/v2/users/{userId}
To use this api, You may pass
aaaId in userId, or
userCode/uniqueCode with prefix 'ref::'
Path Parameters
userId
string
*
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Responses
200
Get User Response
object
error
Error
data
UsersSchema
request
Request
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/app/api/v2/users/{userId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/app/api/v2/users/{userId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
default
// Get User Response 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "id": "users:<uuid>",
    "state": "onboarding:onboarding",
    "participantType": "users",
    "name": "AmazonIndia1",
    "owner": "tenants:<uuid>",
    "uniqueCode": "external-ref-id",
    "category": "",
    "subCategory": "",
    "templateId": "template:<uuid>",
    "properties": {},
    "createdAt": 1257894000,
    "createdBy": {
      "id": 7,
      "name": "shivam"
    },
    "updatedAt": 1257894000,
    "updatedBy": {
      "id": 7,
      "name": "shivam"
    }
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
// Get User Response 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": {
    "id": "users:<uuid>",
    "state": "onboarding:onboarding",
    "participantType": "users",
    "name": "AmazonIndia1",
    "owner": "tenants:<uuid>",
    "uniqueCode": "external-ref-id",
    "category": "",
    "subCategory": "",
    "templateId": "template:<uuid>",
    "properties": {},
    "createdAt": 1257894000,
    "createdBy": {
      "id": 7,
      "name": "shivam"
    },
    "updatedAt": 1257894000,
    "updatedBy": {
      "id": 7,
      "name": "shivam"
    }
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
﻿
﻿
Updated 15 Mar 2024
Did this page help you?
Get a list of Users.
Update a User by id or external ref