users

List

Returns a list of User objects.<Footer>{/* BEGIN_FILESTORAGE_USER_FETCH_SUPPORTED_FIELDS /}<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+WTb2/aMBDGv8rklygko4xVjTRNQFgLGqZr02pdVUVHcgSD/wTbAUrV7z4l0Ba2ausktGraq9inu+d8v3tyR2KwmCp9S3wyYhyNVRpSJA4RKkFOfHJhUBOHQMYoCNxNi+YHxCEmzzKlLSafGPLEnGgcEZ94AnWK1VyyEcPE26rymLSYarBMSeM9VldHZTlxCGdyikkzjlUu7Qv01vlVWBf8cDUeZ8YSh2RgjB1rlafjM5zlaF4iXbyOo0BpgVcTsOBtyVT1Wue5WDFHghwtJgFYCNBiXAy8aTm2NjO+542RZ27Z3k1w7qH0QFsWczReo350cHjUqG5Uyu4fo5R/qFUms6EaHlaiNOYR5JV+GC9p2F3QSfqOtt8t6eqiQVfTFZ1M31aiFCr9sN8YhFf1QdCsDZ5JiM7ffz26bAWtHq3Eq06dTq4WNIxr/TCeDlfdeu84XvROvizp6uqgH1zUadhp9I5VbdA+M/32meo3XZc4ZHuvxL++2w5szNNSy93Erijs9gRkvQrIWDXLh5zFrqm7IGClJCyMGyvhCUwYeKcc7Ehp0VLLyMxy0BhNqF58O5RuJtMH+EzJR/LEJx160qTtTrDrhuYcGIchR+JbneNPhib+NUEBjEeQJBpNsdotj2SoBTOmHNohqVZ5VhyYiUTxH0koP7tZGoWyGBUr3b1FGdjxU4gl5Ka4zHKmMTkFDQIt6uJJN/fOc4ADrbLhviFvRB9Ai8/ycixv/wro1+Z5rFTK8U2g2Rz3A3WtGJWK0XlJ9L8gOZC4R4oP1hxITEqS5hVI/orgnwM6H4PGU8Wk3S+iUjcrdH8PiTbD7mXnnzLbzf13o8M9fMYIAAA=" />{/ END_FILESTORAGE_USER_FETCH_SUPPORTED_FIELDS */}</Footer>

get/filestorage/v1/users

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/filestorage/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.

email_addressstring

If provided, will only return users with emails equal to this value (case insensitive).

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_shell_databoolean

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

is_mestring

If provided, will only return the user object for requestor.

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.