Retrieve user info

Introduction

Navigating user information can be fundamental for administrative purposes, be it for auditing, management, or integrations. In the Circularo API, we have simplified this process to make user data retrieval intuitive and efficient.

Requirements

Circularo admin account: This grants you the necessary permissions to access user data.

Read more about Circularo administration - User administration
User identifier (email)

Get single user

Endpoint

CODE

GET /users/:id

Request

JSON

GET /users/derek.trotter@circularo.com?token=zcCgueTovBQw1jkAmLVOyA61xU6vDrht1ELxIIu0KntWDfCLP9pKHELFd05wYvgc

Response

JSON

{
  "name": "derek.trotter@circularo.com",
  "fullname": "Derek Edward Trotter",
  "group": [
    "1a543afe-a78b-43a1-8788-e4a849ad5bdd",
    "317bec0f-c9c0-470b-9f8f-d22bf52fb72c",
    "494f4f2f-4215-452c-b004-1bcad4706626"
  ],
  "role": "Senior Retail Operations Assistant",
  "id": "derek.trotter@circularo.com",
  "password": "$2b$10$fxLrUeWWk4Ay8uq4ma3bXedlN8isnahl7xPljgRgHxgN3hrb/hdQO",
  "status": "active",
  "mail": "derek.trotter@circularo.com",
  "phone": "+971555666055",
  "timezone": "Europe/Prague",
  "timeformat": "h:mm a",
  "dateformat": "dd/MM/yyyy",
  "firstDayOfWeek": 1,
  "version": 10,
  "providers": [],
  "disabledIntros": [
    "first_login"
  ],
  "image": null,
  "stamp": [],
  "company": "Circularo",
  "termsAccepted": true,
  "createType": "internal",
  "registeredOn": "2022-09-05T11:04:07.444Z",
  "statusChangedOn": "2023-03-24T11:43:00.598Z",
  "termsAcceptedOn": "2022-09-05T11:04:07.444Z",
  "backgroundJobs": [],
  "templateUsage": [
    {
      "count": 10,
      "custom": false,
      "lastUsed": "2023-02-23T11:57:15.928Z",
      "template": "d_default"
    }
  ],
  "autoTimezone": true,
  "customFields": {},
  "config": {
    "delegation": {
      "time": {}
    },
    "language": "en",
    "navigationOpen": true,
    "notifications": {
      "enableAlerts": false,
      "inApp": [
        "documentCommented",
        ...
      ],
      "mail": [
        "documentCommented",
        ...
      ]
    },
    "photo": {},
    "scheduler": true,
    "signature": [
      {
        "imageId": "3a1l8in3iwvslmw2v6drq39t5gw2hqpysh1rqoxt5mz9szjvmblybsxuwuabncud",
        "name": "default"
      }
    ],
    "view": "tableView"
  },
  "identities": [],
  "team": "494f4f2f-4215-452c-b004-1bcad4706626"
}

Key Attributes Explained:

Personal Info - This includes fields like email, fullname, phone, role, name. They give an overview of the user's identity.
Password - A securely hashed representation of the user's password. Note: This can't be reverse-engineered to the actual password
Group - Lists out the group IDs or group names the user is part of. It helps understand their affiliations or teams within the organization.
Status - Reflects the current state of the user, be it active, suspended, or newly_created (= Invited).
Notifications - notifications setup in user preferences