Jump to Content
Guides
API Reference
Changelog
API Reference
Moon (Dark Mode)
Sun (Light Mode)
Guides
API Reference
Changelog
List and search users
Search
All
Pages
Start typing to search…
JUMP TO
Heyteam API
Configuration
Get Languages
get
Get Roles
get
Get Tags
get
Templates
Get Program templates
get
Get Requirements Category templates
get
Get Requirement templates
get
Get Requirement template by id
get
Replace Requirement template Options.
put
Get Custom Field templates
get
Users
List and search users
get
Create a user
post
Add a user onboarding to the queue
post
List deleted users from a deleted date and time (UTC)
get
Get user by id
get
Update user by id
put
Delete user by id
del
List and search user's requirement
get
Get surveys of a user
get
Add a user to a program with an optional arrival date
post
Activate a User as an team member.
post
Add an active user to a role
post
Add supervisors to a user
post
Get user by custom field.
get
Update User's custom field value by custom field key.
put
Close user's active programs and create offboarding
get
Users Requirements
List and search company's user requirements
get
Get user requirement by id
get
Update user requirement by its id
put
Users Programs
List user programs
get
Get user program by Id
get
Delete draft programs created for more than 2 months
get
Offices
Get offices
get
Create an office
post
Get an office
get
Update an office
put
Delete an office
del
Update an office by custom field
put
Departments
Get departments
get
Create a department
post
Get a department
get
Update a department
put
Delete a department
del
Update a department by custom field
put
JobPositions
Get job positions
get
Create a job position
post
Get a job position
get
Update a job position
put
Delete a job position
del
Update a job position by custom field
put
Contracts
Get contracts
get
Create a contract
post
Get a contract
get
Update a contract
put
Delete a contract
del
Update a contract by custom field
put
Repositories
Get available repositories
get
Get items in a repository
get
Add an item into the repository
post
Update a repository item
put
Remove an item from the repository
del
Update items from a repository with given input array
put
Creates items from a repository with given input array
post
Custom Fields
Get Custom Fields
get
Get a custom field
get
Update a custom field
put
Surveys
Get surveys
get
Files
Get file link from uuid
get
Queuing
List processed jobs sorted by descending date
get
Show a processed jobs
get
Powered by
List and search users
get
https://{customerDomain}.heyteam.com/eapi/users
List and search users
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
URL
Base URL
https://
default
.heyteam.com/eapi
/users
Response
Click
Try It!
to start a request and see the response here!