users list
GET {{baseUrl}}/users
Returns a list of User
objects.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
created_after | string | If provided, will only return objects created after this datetime. | |
created_before | string | If provided, will only return objects created before this datetime. | |
cursor | string | The pagination cursor value. | |
include_deleted_data | boolean | Whether to include data that was marked as deleted by third party webhooks. | |
include_remote_data | boolean | Whether to include the original data Merge fetched from the third-party to produce these models. | |
modified_after | string | If provided, will only return objects modified after this datetime. | |
modified_before | string | If provided, will only return objects modified before this datetime. | |
page_size | number | Number of results to return per page. | |
remote_id | string | The API provider's ID for the given object. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Accept | string |
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}]}