users list

GET {{baseUrl}}/users

Returns a list of RemoteUser 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.
emailstringIf provided, will only return remote users with the given email address
include_deleted_databooleanWhether to include data that was deleted in the third-party service.
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":"b82302de-852e-4e60-b050-edf9da3b7c02","remote_id":"344321","first_name":"Shensi","last_name":"Ding","email":"hello@merge.dev","disabled":true,"remote_created_at":"2020-11-10T00:00:00Z","access_role":"TEAM_MEMBER"},{"id":"b82302de-852e-4e60-b050-edf9da3b7c02","remote_id":"344321","first_name":"Shensi","last_name":"Ding","email":"hello@merge.dev","disabled":false,"remote_created_at":"2020-11-10T00:00:00Z","access_role":"LIMITED_TEAM_MEMBER"}]}