Users

Overview

Users identify individuals within an account and are linked from your corporate directory. Each user gets a team key assigned when they become team members. The Users List route supports pagination.

The users object

JSON

{
  "identifier": "...",
  "externalIdentifier": "...",
  "firstName": "...",
  "lastName": "...",
  "title": "...",
  "email": "...",
  "pictureURL": "...",
  "status": "...",
  "source": "...",
  "lastActiveDateTime": "...",
  "createdAt": "...",
  "updatedAt": "...",
  "visited": true,
  "onboarded": true,
  "activeAccessKeyCount": 1,
  "listAccessKeys": [],
  "account": {
     "identifier": "...",
     "name": "..."
   },
  "submittedJobs": 1
}

Parameter	Type	Description
identifier	string	The user's identifier.
externalIdentifier	string	The user’s identifier in the client’s authorization system. Currently, it is set to the user’s email.
firstName	string	The user’s first name.
lastName	string	The user’s last name.
title	string	The user’s title. It can be any value with max length of 50. Defaults to null.
email	string	The user’s email.
pictureURL	string	The location where the user’s picture is stored.
status	string	The user’s status. Values can be Active, Inactive, Invited, Rejected, or Deleted.
lastActiveDatetime	string	The last time the user sent a request in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
createdAt	string	The date the user was created in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
updatedAt		The date the user was updated in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
visited	boolean	Highlights new users in the User Management interface by defaulting to false upon user creation. It gets updated to true once the user is listed in the interface.
onboarded	boolean	Displays Modzy’s welcome video in the interface by defaulting to false upon user creation.
activeAccessKeyCount	number	The amount of active API keys that the user has.
listAccessKeys	array	Contains all the API key objects.
account	object	The user’s account.
submittedJobs	number	The API key’s submitted jobs.