Employee
The Employee API allows the user to access employee information.
Security
jwt-bearer-token
apiKey | API Key |
|---|---|
Name | Authorization |
In | header |
Endpoint
GET /employee/{id}
Summary
Get the employee information using the employee_id.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
path |
| string | Yes | The employee's ID |
query |
| string | No | The projection fields that users need to return |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
400 | Bad request, for more information look at body error | |
401 | Unauthorized error | |
403 | Forbidden error | |
404 | Not Found | |
422 | Unprocessable error | |
500 | Internal Server Error |
Data Models
employee_get_response_1
Field Name | Type | Description |
|---|---|---|
| object | The back of house (BOH) employee schema definition |