List and search users

get

https://{customerDomain}.heyteam.com/eapi/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

relations

string

The list of relations that will be retrieve as object or list of object in the returned json.
Available values of the list: contract, office, department, jobPosition, customFields, repositories (custom entities without program_id), customEntities (custom entities with program id), programs, supervisors.
⚠️ "requirements" value is now deprecated so please use the following endpoint : /eapi/users/{id}/requirements

per_page

integer

≤ 200

Defaults to 20

Paginate the results according to per_page value ("default:20, maximum:200")

professional_email

string

Filter users by professional_email

firstname

string

Filter users with this firstname search string

lastname

string

Filter users with this lastname search string

updated_after

string

Filter resources updated after the updated_after date-time (UTC timezone)

program_type

string

Precise which program type to search users from

program_status

string

Precise which program status to search users from (it needs to have inProgramType set as well)

all_requirements_done

boolean

Get only users who have fill all their requirements

withoutPagination

boolean

Allows to deactivate pagination

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation

400Bad request

401Unauthorized

429Too Many Requests