/users

Returns a list of RemoteUser 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.
emailstringOptional
If provided, will only return remote users with the given email address
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_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_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
remote_idstringOptional
The API provider's ID for the given object.
show_enum_originsenumOptional
A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
Allowed values:

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1bbVPaShj9K04+Oryo6G115s4dBBGogAXU2k4n87B5CAubbNxsQOj0v98JSYBYry26CeDcb7ImJ8l53k82PzQCEk0uptqZBtLVMprFDWTamdZGi0u8cVFoGQ0c2gQLg4P08ZGW0VzPcbiQaFQoMsOtCuxrZ1reQmFi1rNpn6KRB+nmqS3RFCApt9384qxsf36altEYtUdoFAnhni1fwAmOy0Jw4JOf/r9dqWU0B1xXDgT3zEEbHzx0X4L074ahhbYEljVAQn7l9KwIzn9uzb9vAxlKNMogoYwSif+A4aUGUjruWT4/QObk5pfNGTjOo50HISlh6OZPCqdHH05PsiHK/Or/6Cb7+3B/+NDjvQ/7ukmYDt5+o0sem93apDk0j5ul48fm7OakORvNmsPRwb5uwn6j2zhpde8LrXLxsPXMAXrnry+nt+fl83pzn8wuCs3h/aTZJYeNLhn1ZrVC/ZJM6tXPj83Z/VGjfFNodi9O6pf8sFVqu41SmzeKuZyW0VbtqJ19+7G6EDpH0XEYJWDLjgQyip9Ts8DEFW4Ca4BDs47XY5Tk3EIOLJhxGyZujnArb6FBIR/H1DsPHgjUr7jJ9cl59f62fZUbOmZkD8rthTG0M+2iWS02SxfluGMUx0AZ9BhqZ1J4+Isva2ffNCCSjqmk6M7df34PwaNntD4VrtRt/5kzGoPl32IeM7pvy/gv3QE50L77aw8eFWhcgwALJQr/Yt9/Zp5l0x30popI9KFi3BW8z3cwnuQcO2HuDOr6hxtaRkMLKHvK34AKapu6BTaYKPQ+F/qQ99xfmCXCozJ+wG/oXixR/+Kei0L3qRRjihN3bWOMQXoC1ZjjmoHsc2GFoIkYQQ3Ja7J0DlaP82pbDU0R2qrjJhLszzrmGoG96mnrMiYQZ4qiPMBKnK0n2fD1Ab6IRhS6S7hAAsL41SnnzBKBINHQQSZrDo+xARe2ojgX3EEhp/phbQmmL1aPLtFGQclypRDabrFwHN1QIjlik34fPtdeO0g6fhO2V2LcM9RQ3wvxdbHE14mPr7sBx53zslMbjZOvgH/A8tuK25rUl4rdjhqSfaRYV1E/bo4e+EXyHdkGW4l12WYwVVUQo74hwIwc+aA6sU/KVxvNEK/hhZPRhAtFY8ICLvnyRwi6ri44wz+ofn/qeSnVtxIXNgpXchv3usDQllfUVmWCJfY2dGzpRrlABlLxeBCChnG+0fhOyT2N3C21CVVLY3nsY+p/teCemP331khVGEgyEGopC0H1kVUqDWoPW9EjpemHFV9TBKpoDIjQYllxGyjdsKZSEegOJIKliOYILuQ5EYrXq/dp+uwlKuIxSgKXaOmP41vy6fAkGW9VpSNsWY91KRDtAfdcRe3AEi/l3vYlDTxh1YcLE2w6i6eXZKz75jRWbasULqptfY6WuK23N5PRUq2hSKGIclnNh0y9kd5KQaIOs5kqQSLAiklAd59Jo9ww0k5Pu10y6rxXNAxU3MUPeQ981CT9/olJ4kVi541SpmNQa5MQNH1bbG+6r/Nex+8DFKWkEC2bntO/ZpBNhscxVaVBhWCJj6w7VDe5Kj1gmQuoHYn4U+PwArxPiXL837S+hso16bvCsar6NoeKNR383vw4Pb975zNRv+8zvFvDUQNskMDUBk4I+t6k3JbNpn1Fe0EiquaYNIUquEneBBCGexXPpdzey0ZbCqhtqhzMg6voS/BE2+p3qo2FpvJfPXI1ZplDpSyMvcEGO5nEr6ntcGpLRakpRNtBOSalKGlHt9BnfKKG9AVkhfFJrHc6cGbDSuUoja2Cu9Psd8DEPVUqmQ+mr8hkhd7k+ENjl+pGYjQXr/c63jy3VoBILlxFjMcwY+5+Tr5ws3KQ9qiQ1myw8Ze6HQuEXGQbVfaMg8YMOvw4vupf3KXQ4m7fO69ULOp3WDhTO5YEmFtgs83JnuH2u2lfVVu1Qm2AuyWCfzqlJHjsNmJf3VwR4P2vgS5JRrAkUMYVKXlLvE1ubVAxziXJOfM9MVI1UJHALwPY6PsITHSb6ZvG590ungL6fao6xQeg+rBr1E++JrPz/7dlNEGPF7SHDijS7ZakBahb/LVlkqTefLrcuxZ8RRxVQ+/Np8voHdbR+YPx2EpKbFaesDcu89xxMZo/thJDRGix4ag1ZqzJTneooqYcFj5rBih+6RKCpqHwPMv0Oh/WplIFv/LBIvOopdpHjnqYJDuYGL8v+eiLLvj9579p8GW+ckUAAA==" />