Search Results

Input and Output of Retrieve Leads

When you use the Leads resource, the information in the Input and Output tabs varies depending on the endpoint that you select.

Input and Output for Lead by Id

If you select the Lead by Id endpoint, the Input tab contains the following element:
Input Item Data Type Description
id Integer The ID of the lead.
The Output tab contains the following elements:
Output Item Data Type Description
requestId String The request ID returned from the Marketo server.
result Complex The fields that are displayed in the response. If no fields are selected in the Field Selector tab, the following fields are displayed: id, updatedAt, lastName, email, createdAt, and firstName. If you select a field in the Field Selector tab, the field corresponding to this field is displayed in the Output tab under the fields element.
success Boolean If the request is successful, this value is true.

Input and Output for Multiple Leads

If you select the Multiple Leads endpoint, the Input tab contains the following elements:
Input Item Data Type Description
filterType String The filter types supported by Marketo. For example, Id, cookie, email, twitterId and so on.
Note: If you use a field such as filterValues, ensure that the field is displayed in the response. If the field is not displayed, you have to click the Field Selector tab and select the field.
filterValues Complex A separated list of filter values.
batchSize Integer The maximum number of records to be returned. The default maximum number of the batch size is 300.
nextPageToken String This parameter is used to paginate through large result sets. This value can be used to access next set of records.
Note: The value of the next page token is obtained from the output of the previous activity.
The Output tab contains the following elements:
Output Item Data Type Description
requestId String The request ID returned from the Marketo server.
result Complex The fields that are displayed in the response. If no fields are selected in the Field Selector tab, the following fields are returned: id, email, updatedAt, createdAt, lastName, firstName, cookies, twitterId, facebookId, linkedInId, sfdcAccountId, sfdcContactId, sfdcLeadId, and sfdcLeadOwnerId.

If you select a field in the Field Selector tab, the field corresponding to this field is displayed in the Output tab.

success Boolean If the request is successful, this value is true.
nextPageToken String This parameter is returned by an API call. This value can be used to access next set of records.

Input and Output for Multiple Leads by List

If you select the Multiple Leads by List endpoint, the Input tab contains the following elements:
Input Item Data Type Description
listId String The ID of the list that you want to retrieve.
batchSize Integer The maximum number of records to be returned. The default maximum number of the batch size is 300.
nextPageToken String This parameter is used to paginate through large result sets. This value can be used to access next set of records.
Note: The value of the next page token is obtained from the output of the previous activity.
The Output tab contains the following elements:
Output Item Data Type Description
requestId String The request ID returned from the Marketo server.
result Complex The fields that are displayed in the response. If no fields are selected in the Field Selector tab, the following fields are returned: id, email, updatedAt, createdAt, lastName, and firstName. If you select a field in the Field Selector tab, the field corresponding to this field is displayed in the Output tab.
success Boolean If the request is successful, this value is true.
nextPageToken String This parameter is returned by an API call. This value can be used to access next set of records.

Input and Output for Lead Activity

If you select the Lead Activity endpoint, the Input tab contains the following elements:
Input Item Data Type Description
activityTypeIds Complex The ID of the activity type that you want to request. The default maximum number of the multiple type is 10.
nextPageToken String This parameter is used to paginate through large result sets. This value can be used to access next set of records.
Note: The value of the next page token is obtained from the output of the previous activity.
batchSize Integer The maximum number of records to be returned. The default maximum number of the batch size is 300.
listId String This parameter serves as a filter, and returns leads that belong to a specified list activities for leads in the given list.
sinceDatetime DateTime This parameter is used to get the lead activities since the date time is specified. It is usually used in the first call.
Note: For all the Datetime type in the plug-in, it supports XSD Datetime type format. For example, 2002-05-30T09:00:00, 2014-10-06T13:22:17-08:00. It does not support 2014-10-06T13:22-07:00, 2014-10-06.
The Output tab contains the following elements:
Output Item Data Type Description
requestId String The request ID returned from the Marketo server.
result Complex The fields that are displayed in the response. The following fields are displayed: id, leadId, activityDate, activityTypeId, primaryAttributeValueId, primaryAttributeValue, and attributes.
success Boolean If the request is successful, this value is true.
nextPageToken String This parameter is returned by an API call. This value can be used to access next set of records.
moreResult Boolean If this value is true, more results are available.

Input and Output for Lead Changes

If you select the Lead Changes endpoint, the Input tab contains the following elements:
Input Item Data Type Description
nextPageToken String This parameter is used to paginate through large result sets. This value can be used to access next set of records.
Note: The value of the next page token is obtained from the output of the previous activity.
batchSize Integer The maximum number of records to be returned. The default maximum number of the batch size is 300.
listId String This parameter serves as a filter, and returns leads that belong to a specified list activities for leads in the given list.
sinceDatetime DateTime This parameter is used to get the lead activities since the date time is specified. It is usually used in the first call.
Note: For all the Datetime type in the plug-in, it supports XSD Datetime type format. For example, 2002-05-30T09:00:00, 2014-10-06T13:22:17-08:00. It does not support 2014-10-06T13:22-07:00, 2014-10-06.
The Output tab contains the following elements:
Output Item Data Type Description
requestId String The request ID returned from the Marketo server.
result Complex The fields that are displayed in the response and the following fields are displayed: id, leadId, activityDate, activityTypeId, attributes, and fields.
success Boolean If the request is successful, this value is true.
nextPageToken String This parameter is returned by an API call. This value can be used to access next set of records.
moreResult Boolean If this value is true, more results are available.