benefits list
GET {{baseUrl}}/benefits
Returns a list of Benefit objects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
employee_id | string | If provided, will only return time off for this employee. | |
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id":"19202938","employee":"d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name":"Blue Shield of California","benefit_plan_type":"MEDICAL","employee_contribution":23.65,"company_contribution":150,"remote_data":[{"path":"velit deserunt qui","data":{"incididunt7b":{},"ut_f9d":{},"consequat8":{}}},{"path":"sit amet enim","data":{"incididunt8_4":{}}}],"remote_was_deleted":true},{"id":"3fe5ae7a-f1ba-4529-b7af-84e86dc6d232","remote_id":"19202938","employee":"d2f972d0-2526-434b-9409-4c3b468e08f0","provider_name":"Blue Shield of California","benefit_plan_type":"MEDICAL","employee_contribution":23.65,"company_contribution":150,"remote_data":[{"path":"laboris cupidatat reprehenderit","data":{"dolor__3":{}}},{"path":"fugi","data":{"mollit3e7":{},"utb05":{},"proidentf0f":{}}}],"remote_was_deleted":true}]}