A Nex staff member is a user account in the NexHealth web app.
Before you start
- Every request needs a bearer token from
POST /authenticates. See Authentication. - Requests take the practice's
subdomain. See Institutions, syncs, and locations.
Overview
The view Nex staff endpoint returns the staff members of an institution. Filter the list by inactive status, or by the locations a staff member has access to with location_ids[].
Results come in pages. Set page and per_page. The default is 5 per page and the maximum is 300.
Nex staff resource
Each staff member in data looks like this.
{
"id": 1,
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:20:57.007Z",
"patientable": false,
"inst_ids": [1, 2, 3],
"unsubscribe_emails": true,
"inactive": true,
"unsubscribe_sms": true,
"location_ids": [1, 2, 3]
}inst_ids lists the staff member's institutions. location_ids lists the locations they have access to. created_at and updated_at are in UTC.