/leads/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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

email_addresseslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

email_addresseslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

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 lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	response = client.crm.leads.remote_field_classes_list(
8	cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
9	)
10	for item in response:
11	yield item
12	# alternatively, you can paginate page-by-page
13	for page in response.iter_pages():
14	yield page

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	}

/leads/remote-field-classes

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration