/engagement-types

Returns a list of EngagementType objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
include_deleted_databooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idstringOptional
The API provider's ID for the given object.

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WYb2/TMBDGv0rll1XasJUOVgmh0g66oWSjzQYDTdHVuSZundiznXYt4rujpH/YYEKweZS+TOR7bP/83F2cr4SCwVioOWkRqlLikFREyEmLHGUxxJhiZoK5ROIQkMyHFJcDw+k+cYjOpRTKYPSWIY90T+GItIibooqxlmdsxDByqUpdlhmMFRgmMu1uomqjMow4hLNsglGbUpFn5jc6y3E1WA786VG7nGlDHCJBa5MokcdJH69z1L+TLFbDy30Cr0VgwL0VXlPL+PveFeuOkKPBqAsGumiQFhtcTZUYI3XLdRPksl5OW49w6mLmgjKMctRus3G4/+KwWVuplLO/DmP+aq86vh6K4YtqGFMeQl71AnrjB8czfxw/9zvPb/zFedNfTBb+ePKsGsZQ9QKveRpcNk677b3TewaEg4NPhxdvum9O/CpdHDX88eXMD+ieF9DJcHHcOHlHZye9Dzf+4nLf6543/OCoefJO7J12+trr9IXXrteJQ26fI2l9+Xr7xcocbUqRi7tjj1OI8RaT5SmAZDWZDzmjdd2oQwoLkcFM16lI3RQjBu4ZBzMSKoVSM9TXOSisyyxeo2ci23AvPOv32n7nqHvXA+0pMA5DjqRlVI6/2Ja0vhCghk2ZmYdmaXbcuJ84JCt2duWQ4uCZwugMFKRoUBWhV9+c+zEYNsUOpBJYnNnBcVdzjWMsdwBHB6TOOdq1xUp0S4YoAKTCYMiiv6bBhbbNopDckhc2JIoCdvcplGCSv8YjpERlmU+p+b8CeoSXevlwIIWxQ6uXD7UUZjulRT+wthxnmsWJ4XM7DDZy2+03j7DEewRpN3smCHKn2q/HqBJajEylO88gZVRXGgfNygA4arto1vqNg2apvh1MD80dPzc6Qc7tMFmr7V7KnDGJkWJTy115I7utUvqUnae0+4iDsgzth+7/2q4fBEoo+iSgCt1/n3CPLz2DPAbV6Xt2mehCtfhBsUvdKkBIOUJk66P3h97uVeJi7TOhJhXr1lgrh52+t93L81NW5QvDYtuXp2mpuVMp9RmzCPWkMrD2cbOGsVIOX87MfhB83BEcIhH2M2ohErG1WvsHfefq23eqfHPJ4RYAAA==" />