users list

GET {{baseUrl}}/users

Returns a list of User objects.

Request Params

KeyDatatypeRequiredDescription
created_afterstringIf provided, will only return objects created after this datetime.
created_beforestringIf provided, will only return objects created before this datetime.
cursorstringThe pagination cursor value.
include_deleted_databooleanWhether to include data that was marked as deleted by third party webhooks.
include_remote_databooleanWhether to include the original data Merge fetched from the third-party to produce these models.
modified_afterstringIf provided, will only return objects modified after this datetime.
modified_beforestringIf provided, will only return objects modified before this datetime.
page_sizenumberNumber of results to return per page.
remote_idstringThe API provider's ID for the given object.

HEADERS

KeyDatatypeRequiredDescription
X-Account-Tokenstring(Required) Token identifying the end user.
Acceptstring

RESPONSES

status: OK

{"next":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous":"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results":[{"id":"0358cbc6-2040-430a-848e-aafacbadf3aa","remote_id":"19202938","name":"Gil Feig","email":"merge_is_hiring@merge.dev","is_active":true,"remote_data":[{"path":"proident enim","data":{"consequat47_":{},"est8":{}}},{"path":"sed aute","data":{"officia3_6":{}}}],"remote_was_deleted":true},{"id":"0358cbc6-2040-430a-848e-aafacbadf3aa","remote_id":"19202938","name":"Gil Feig","email":"merge_is_hiring@merge.dev","is_active":true,"remote_data":[{"path":"qui ut non anim","data":{"dolor_a15":{},"ad_c":{}}},{"path":"nulla ex culpa aliqua","data":{"amet_7":{},"velit58d":{},"pariatured":{}}}],"remote_was_deleted":false}]}