users

List

Returns a list of User objects.<Footer>{/* BEGIN_CRM_USER_FETCH_SUPPORTED_FIELDS /}<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+2Yb2/iOBDGvwrySxTItSzdK9JqxQK30FPSHqS9666qaHCGYHDi1HagZbXf/ZTwp9CrutdbQ7qnfYVs7MeT3zwaT/KFUNAYCnlPGoTKiFgkEgFy0iCXCiWxCCTMhQiXf/uzY2IRlSaJkBqD3xjyQHUljkiD2BHKECtpzEYMA5vKyGaxxlCCZiJW9mZXZZRvIxbhLJ5i0KRUpLF+Rme5rgLLhY+GyuZMaWKRBJTSYynScNzH2xTVc5JZNBwjjDXwSgAa7K3tFbnc/9RcFneAHDUGbdDQRo00e8DVUWOtE9Ww7THypJofWw1wZmNsg9SMclR2vXZ6/Pa0Xlmp5Ke/90P+7qg8uR2K4duyH1LuQ1p2PHrner25OwnfuK03d+7isu4upgt3Mv2l7IdQdjynfu5d187bzaPzJxb4g5O/Tq8+tD+cuWW66NTcyfXc9eiR49HpcNGrnX2k87PuH3fu4vrYaV/WXK9TP/sojs5bfeW0+sJpVqvEItt5JI3PX7YnVuZoUopc7K7tRRDiFpNlFiBhlSQdckarqlaFCBYihrmqUhHZEQYM7AsOeiRkBLmmr25TkFhN4nCNnol4w500SMftNt1Wp73rgeYMGIchR9LQMsV/2JY0PpO1hYhFMALGs984hDA3RjbLlA9UsxlmbkXIXRtnT2yRWGjMhiJXTWOmWT6WGAmNfpbV3ZGfgB4/TLGAWESDmipyk03epkxicAESItQos/huvlpPs84iakGUAAtjM8x3NdfMJ4l55mvQK4wvwPVCTC1IVMrRrCdXosW7sXAXtrhQpuFmkns13S7P4hmKJMlvWZMQc829UPymQQsH2k2Hg0RoM0S76VAlQn+7GLpNr3fV+S6eVMQaaDE30aYf+278vVixcKz5vZkEbOR+9gCPSf+OkJitG1OEZJ+c13CfucT2j81hVAolRrrUvo8hYlSVaif10gB4HoBBnGv92kk9Vz+QhYusI1tpsUiqUPqp5C/NkJtqNUbOzWRjrVZ85VgxPnyluGAJBnIZhEF/b2T33Wm80pvxvzs8I8dZbKzvW8sd+JLcbyF5IdO8xI44SMMuf9AtpqF+FRVkCUFIuhe4me7/+VY0110P0hBkq++YzYLKVLNvuz977Ee8PYQoC8ZUpX7QKx5yYcUkgzAXcloybuS1st/qO/v8gPljmvlKs9D0p6ZZrnmIl8Z/DfhwLccnjANU09LA2MvKGutK2f91ro8978/ii8WrMfEnMRbmC8dCjMXhLsAf6Q395uvfk0SvIyEeAAA=" />{/ END_CRM_USER_FETCH_SUPPORTED_FIELDS */}</Footer>

get/crm/v1/users

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/crm/v1/users
  • Auth: HTTP bearer

Query parameters

created_afterstring date-time

If provided, will only return objects created after this datetime.

created_beforestring date-time

If provided, will only return objects created before this datetime.

cursorstring

The pagination cursor value.

emailstring

If provided, will only return users with this email.

include_deleted_databoolean

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.

include_remote_databoolean

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

include_remote_fieldsboolean

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

include_shell_databoolean

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

modified_afterstring date-time

If provided, only objects synced by Merge after this date time will be returned.

modified_beforestring date-time

If provided, only objects synced by Merge before this date time will be returned.

page_sizeinteger

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

remote_idstring

The API provider's ID for the given object.

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

nextstring nullable
previousstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.