Get Benefits
Returns a list of Benefit objects.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Query Parameters
The ID of the employee.
The ID of the employer benefit.
The third-party API ID of the matching object.
Whether to include the original data Bindbee fetched from the third-party to produce these models.
Whether to include custom fields in the response.
If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)
Number of results to return per page. Maximum size is 100.
1 <= x <= 1000
The pagination cursor value.
If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with effective_date same or after this date time will be returned. Format: DateTime (ISO 8601)
If provided, only objects with effective_date same or before this date time will be returned. Format: DateTime (ISO 8601)
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.
Response
Successful Response
The response is of type object
.