/engagements/remote-field-classes

Returns a list of RemoteFieldClass objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

cursorstringOptional

The pagination cursor value.

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).

is_common_model_fieldbooleanOptional

If provided, will only return remote field classes with this is_common_model_field value

is_custombooleanOptional

If provided, will only return remote fields classes with this is_custom value

page_sizeintegerOptional

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

Response

nextstring or null

previousstring or null

resultslist of objects or null

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The engagement's owner.

contentstring or nullOptional

The engagement's content.

subjectstring or nullOptional

The engagement's subject.

directionenum or nullOptional

The engagement’s direction.

INBOUND - INBOUND
OUTBOUND - OUTBOUND

Allowed values:

engagement_typestring or nullOptionalformat: "uuid"

The engagement type of the engagement.

start_timedatetime or nullOptional

The time at which the engagement started.

end_timedatetime or nullOptional

The time at which the engagement ended.

accountstring or nullOptionalformat: "uuid"

The account of the engagement.

contactslist of stringsOptional

remote_datalist of objects or nullOptionalRead-only

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.engagements.remoteFieldClassesList({
5	cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
6	includeDeletedData: true,
7	includeRemoteData: true,
8	includeRemoteFields: true,
9	includeShellData: true,
10	isCommonModelField: true,
11	isCustom: true,
12	pageSize: 1
13	});
14	for await (const item of pageableResponse) {
15	console.log(item);
16	}
17
18	// Or you can manually iterate page-by-page
19	let page = await client.crm.engagements.remoteFieldClassesList({
20	cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
21	includeDeletedData: true,
22	includeRemoteData: true,
23	includeRemoteFields: true,
24	includeShellData: true,
25	isCommonModelField: true,
26	isCustom: true,
27	pageSize: 1
28	});
29	while (page.hasNextPage()) {
30	page = page.getNextPage();
31	}
32
33	// You can also access the underlying response
34	const response = page.response;

1	{
2	"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
3	"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
4	"results": [
5	{
6	"id": "string",
7	"display_name": "string",
8	"remote_key_name": "string",
9	"description": "string",
10	"is_custom": true,
11	"is_common_model_field": true,
12	"is_required": true,
13	"field_type": "string",
14	"field_format": "string",
15	"field_choices": [
16	"string"
17	],
18	"item_schema": {
19	"item_type": "string",
20	"item_format": "string",
21	"item_choices": [
22	"string"
23	]
24	}
25	}
26	]
27	}

/engagements/remote-field-classes

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration