Scope
Below you can find a description of the Member model, which can be useful to have an idea of what to expect in each endpoint.
See the examples attached to each request for more information about the response.
Member Model
| Property | Description | Type |
|---|---|---|
| token_id | Unique identifier for that employee. | string |
| Email of the employee. | string | |
| first_name | First name of the employee. | string |
| last_name | Last name of the employee. | string |
| phone | Phone of the employee. | string |
| employee_number | Employee number in your records. | string |
| role | Role of the employee. The available values for this parameter are: admin, manager and member. | string |
| start_date | Employee start date. Format: yyyy-mm-dd | string |
| end_date | Employee end date. Default is null. If specified, then Everlance will not include this user in reports, will not be charged for, and will not have access to Premium features. Format: yyyy-mm-dd | string |
| leave_start_date | Specify if the employee is going to be on leave. During this period the employee will be excluded from reports. Format: yyyy-mm-dd | string |
| leave_end_date | Specify when the employee will return from leave. After this date employee will be included in reports. Format: yyyy-mm-dd | string |
| leave_reason | Specify a reason for the leave. | string |
| metadata | Array of metadata objects that can be assigned to the employee. See table below. | Array of objects |
| program_name | Specify the program name the employee should be assigned to. If you want to remove the employee from their program send no_program | string |
Metadata object
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | String | Yes | Name of the metadatum |
| value | String | Yes | Value for the metadatum. If the value is null, the metadatum will be archived in Everlance |