Staff members are the system users that consist of both employee and vendor accounts. Personal information about these individuals, such as there phone numbers and email address are stored in these objects.
Listing Staff Members
Returns a collection of staff records, optionally filtered by the available request parameters.
GET /api/v1/staff
Available Request Parameters:
| Name | Type | Required | Description |
| id | integer | no | ID of the staff member. |
| last_name | string | no | Last name of an employee, or name of vendor. |
| first_name | string | no | First name of an employee. |
| string | no | Email address of a staff member. | |
| role | integer | no | ID of the role this contact belongs to. |
| is_vendor | boolean | no | If true, return vendors. If false, return employees. |
| created_from | timestamp | no | Created on or after the date. |
| created_to | timestamp | no | Created on or before the date. |
| updated_from | timestamp | no | Updated on or after the date. |
| updated_to | timestamp | no | Updated on or before the date. |
Note: All timestamp parameters are queried and returned in UTC.
Getting a Staff Member
Returns a single staff record, based on the numeric ID.
GET /api/v1/staff/{staff_id}