v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB

Users

Create User

Creates a user for in an organization. External ID required. Otherwise, the newly created user will contain a user ID which can be used for identification.

post/core/v1/user

Request body

company_namestring

The name of the company the user is part of.

departmentstring

The name of the department the user is part of.

department_idstring

The department ID of the department the user is in.

emailstring

The email of the user.

employee_idstring

The user's employee ID, does not have to be unique.

employee_titlestring

The title of employee.

employee_typestring

The type of employee.

external_idstring

A unique identifier managed externally provided by the consumer.

first_namestring

The first name of the user.

last_namestring

The last name of the user.

middle_namestring

The middle name of the user.

phonestring

The main phone number of a user, E.164 format preferred.

Response

activeboolean

Whether the user is active in the system.