Skip to content

Retrieve user information by id

Request

Security
OAuth2(Required scopes: users.read)
Path
idstring(User identifier)required
Example:6295dcd39db1ab740c3e296c
curl -i -X GET \
  https://api.cloud.hypatos.ai/v2/users/6295dcd39db1ab740c3e296c \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(User identifier)required
Example:"660572bc7a3cd6803f112252"
emailstring(User email)required
Example:"firstname.lastname@company.inc"
namestring(User display name)required
Example:"Firstname Lastname"
companiesAccessArray of objects(User companies memberships)required
activeboolean(If user is active)required
Example:true
isInternalboolean(If user is considered internal Hypatos one)required
Example:false
lastLoginAtstring(Last login date)
Example:"2023-03-28T15:46:19.384990Z"
Response
{
  "id": "660572bc7a3cd6803f112252",
  "email": "firstname.lastname@company.inc",
  "name": "Firstname Lastname",
  "companiesAccess": [
    { … }
  ],
  "active": true,
  "isInternal": false,
  "lastLoginAt": "2023-03-28T15:46:19.384990Z"
}