/users

Returns a list of User objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

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

created_beforedatetimeOptional

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

cursorstringOptional

The pagination cursor value.

emailstringOptional

If provided, will only return users with this email.

include_deleted_databooleanOptional

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_databooleanOptional

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

include_remote_fieldsbooleanOptional

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

include_shell_databooleanOptional

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

modified_afterdatetimeOptional

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

modified_beforedatetimeOptional

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

page_sizeintegerOptional

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

remote_idstringOptional

The API provider's ID for the given object.

Response

nextstring or null

previousstring or null

resultslist of objects or null

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	const pageableResponse = await client.crm.users.list({
5	createdAfter: new Date("2024-01-15T09:30:00.000Z"),
6	createdBefore: new Date("2024-01-15T09:30:00.000Z"),
7	cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
8	email: "email",
9	includeDeletedData: true,
10	includeRemoteData: true,
11	includeRemoteFields: true,
12	includeShellData: true,
13	modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
14	modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
15	pageSize: 1,
16	remoteId: "remote_id"
17	});
18	for await (const item of pageableResponse) {
19	console.log(item);
20	}
21
22	// Or you can manually iterate page-by-page
23	let page = await client.crm.users.list({
24	createdAfter: new Date("2024-01-15T09:30:00.000Z"),
25	createdBefore: new Date("2024-01-15T09:30:00.000Z"),
26	cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
27	email: "email",
28	includeDeletedData: true,
29	includeRemoteData: true,
30	includeRemoteFields: true,
31	includeShellData: true,
32	modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
33	modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
34	pageSize: 1,
35	remoteId: "remote_id"
36	});
37	while (page.hasNextPage()) {
38	page = page.getNextPage();
39	}
40
41	// You can also access the underlying response
42	const response = page.response;

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "0358cbc6-2040-430a-848e-aafacbadf3aa",
7	"remote_id": "19202938",
8	"created_at": "2021-09-15T00:00:00Z",
9	"modified_at": "2021-10-16T00:00:00Z",
10	"name": "Gil Feig",
11	"email": "merge_is_hiring@merge.dev",
12	"is_active": true,
13	"remote_was_deleted": true,
14	"field_mappings": {
15	"organization_defined_targets": {
16	"custom_key": "custom_value"
17	},
18	"linked_account_defined_targets": {
19	"custom_key": "custom_value"
20	}
21	},
22	"remote_data": [
23	{
24	"path": "/users"
25	}
26	],
27	"remote_fields": [
28	{
29	"remote_field_class": {
30	"id": "string",
31	"display_name": "string",
32	"remote_key_name": "string",
33	"description": "string",
34	"is_custom": true,
35	"is_common_model_field": true,
36	"is_required": true,
37	"field_type": "string",
38	"field_format": "string",
39	"field_choices": [
40	"string"
41	],
42	"item_schema": {
43	"item_type": "string",
44	"item_format": "string",
45	"item_choices": [
46	"string"
47	]
48	}
49	},
50	"value": "string"
51	}
52	]
53	}
54	]
55	}

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration