benefits retrieve
GET {{baseUrl}}/benefits/:id
Returns a Benefit
object with the given id
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
expand | string | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
RESPONSES
status: OK
{"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":"qui dolor do culpa","data":{"magna82":{}}},{"path":"ut velit pariatur","data":{"nisi_8a":{}}}],"remote_was_deleted":true}