Employees

Manage employees in Exsited: list, create, retrieve, update and delete employee records.

Employees are the staff records in Exsited, each with a code, contact details and custom attributes. You can list, create, retrieve, update and delete them. This area has 5 endpoints, each available in all seven SDKs.

Deleting an employee cannot be undone. After a delete, reading the employee returns 404.

At a glance

Endpoint	Method	Path	What it does
List employees	GET	/employees	Lists employees, one page at a time.
Create an employee	POST	/employees	Creates an employee and returns it under employee.
Delete an employee	DELETE	/employees/{employee_id}	Deletes an employee; the response has no body.
Retrieve an employee	GET	/employees/{employee_id}	Retrieves one employee by its emp_ id.
Update an employee	PATCH	/employees/{employee_id}	Updates an employee and returns it under employee.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Request bodies go under employee. Both the create and the update wrap their fields in an employee object, and every single-employee response returns it under employee.
• An employee has both an id and a code. The id starts with emp_ and is what these calls take; the milestones-by-employee call takes the code instead.
• A new employee needs only a name. The response gives its id, code and the rest of the record.
• The list pages by cursor. Records are under data; pass pagination.next_cursor as cursor while pagination.has_more is true.