Workleap · Schema

Workleap User

A user account within a Workleap organization

Employee ExperienceHREngagementPulse SurveysPerformance ManagementOfficevibeUser ProvisioningHRISRecognitionOnboarding

Properties

Name	Type	Description
userId	string	The unique identifier of the user
email	string	The user's email address
firstName	string	The user's first name
lastName	string	The user's last name
status	string	The user's account status
jobTitle	string	The user's job title
department	string	The user's department
managerId	string	The user ID of the user's manager
createdAt	string	When the user was created
updatedAt	string	When the user was last updated

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.workleap.com/schemas/user",
  "title": "Workleap User",
  "description": "A user account within a Workleap organization",
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the user"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "The user's email address"
    },
    "firstName": {
      "type": "string",
      "description": "The user's first name"
    },
    "lastName": {
      "type": "string",
      "description": "The user's last name"
    },
    "status": {
      "type": "string",
      "enum": ["active", "deactivated"],
      "description": "The user's account status"
    },
    "jobTitle": {
      "type": "string",
      "description": "The user's job title"
    },
    "department": {
      "type": "string",
      "description": "The user's department"
    },
    "managerId": {
      "type": "string",
      "format": "uuid",
      "description": "The user ID of the user's manager"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the user was created"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the user was last updated"
    }
  },
  "required": ["userId", "email", "firstName", "lastName", "status"]
}