/tasks/remote-field-classes

Beta

Returns a list of RemoteFieldClass objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

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).

is_common_model_fieldbooleanOptional

If provided, will only return remote field classes with this is_common_model_field value

is_custombooleanOptional

If provided, will only return remote fields classes with this is_custom value

page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2YbW/bNhDHv4rBl4YsLXGdNgaKwrW92hmkZI76kBWBcKbOEm1KZPgQJy763QvJD3G6INgKuXGXvdSR/JP83fGO1BdCwWAi1C1pE6oy4pBMxMhJm4SgZ8QhIFkAGS6bo+tD4hBtpRTKYPw7Qx7rgcIJaRMvQ5Vgw+ZswjD2qMo8lhtMFBgmcu1tRjUm5TDiEM7yGcYdSoXNzSM6y34NWHb87lN7nGlDHCJBa5MqYZN0hFcW9WOSxWo4Zpgb4I0YDHhbwxtqOf4hW7HuGDkajHtgoIcGabHB1VSpMVK3PS9FLt1yWjfGaw9zD5RhlKP2Ws3jw5fHrcZKpZz9TZTw1wf16dVYjF/Wo4TyCGzdD+lNEA7nwTR5EXRf3ASL961gMVsE09lv9SiBuh/6rdPwonna6xycPtAhOj/6dPzhbe/tSVCni34zmF7Mg5Ae+CGdjRfD5sk7Oj8Z/HkTLC4O/d77ZhD2WyfvxMFpd6T97kj4HdclDtn2I2l//rJtWAVHh1Lk4n7fYQYJbjFZegEka0g75oy6uulCBguRw1y7VGRehjED74yDmQiVQakZ6SsLCl2ZJ2v0TOQb7qRN+sGgE3T7vfsx0LkGxmHMkbSNsvi3sCXtz2QVQsQhVGSydEcUg8HSkBssm2KLa6OY56iIQxRmwpRWuP8VSTDpnYnFxXExYKwuz814itSQy6L9yjKF8RkoyNCgKpZz+dV5CG0XpLYcq2W7Et0x1SdHx4WuGlwh6U7lfxqbkLKctUpupeaOwe3xKR7Y8bkUphqoAzvWUph1atwLqKWCzZm5/QHEmytBlciHuWZJavhtNdA3cs++Iv2BIKvNDjME+eyx+owqocXE1Hq3OWSM6lrzqFU7B466Wtxr/eZRq1R/QvRAzW5SSiUuCazRKXJeDf612k4473FgnzGJsWLXFV/FNrKPFMCgEw4/9H+dqN1JISzP+ISDqtgBd7o/+wryJGG83K5QdCcYC91HEsP/gVx4wCaguiO/Wv66UC3+bv2kKrgvaTlEyDhCXNVT707vuRW4YudzoWa1ymNzrRx1R/4un3t7DPcvzGPUs9p5ZfewNdyVcvRqbg7D8OM+vjy2Cf5bbiIV1QfkQqTiH+XKHRWsJ34lXH79Bo0AzCkzGQAA" />