Get user information

Circularo REST API example

Return information about selected user. Requires administrator rights.

Step 1 - Sign administrator in

Sign administrator user in.

Endpoint

POST - /login

Example

/login

Content-Type: application/json

{
  "name": "john.doe@circularo.com",
  "password": "!123.my_strongPASSWORD!",
  "tenant": "default"
}

Response

Note following properties in response object:

  • token - In response object at position ‘token‘. It may have value of “i7NleV6WM54nthNspLuFWOumhHwRnGgAryCgXlgBqVbDMfOkPMwsgAQLcYr1vcVk“.

Step 2 - Obtain information about the user

Obtain information about another user.

Endpoint

GET - /users/:id

Example

/users/mary.griffin@circularo.com?token=i7NleV6WM54nthNspLuFWOumhHwRnGgAryCgXlgBqVbDMfOkPMwsgAQLcYr1vcVk

Returned object contains information about the specified user.

Step 3 - Sign out (Optional)

Sign user out.

Endpoint

GET - /logout

Example

/logout?token=i7NleV6WM54nthNspLuFWOumhHwRnGgAryCgXlgBqVbDMfOkPMwsgAQLcYr1vcVk
Circularo.com