marketo op get leads

Get Marketo Lead Information

Version: 17.07

Supported Since: 17.07

Get Marketo Lead Information connector operation provides the facilities to fetch Marketo Leads or related information such as Lead meta data or partitions. This connector operation provides the following sub operations.

All these operations require Read-Only Lead or Read-Write Lead permissions from Marketo API.

Get Leads list

Get Leads list operation can be used to fetch a list of up to 300 leads based on a list of values in a particular field.

Parameters

* marked fields are mandatory

Filter Field *

Basic

The field of the lead records to filter on. This can be specified as a constant value or as a combination of placeholder expressions.

Filter Values *

Basic

A comma-separated list of values to filter on the specified field. This can be specified as a constant value or as a combination of placeholder expressions.

Fields

Basic

A comma-separated list of lead fields to return. This can be specified as a constant value or as a combination of placeholder expressions.

Batch Size

Basic

The size of the batch to return. The maximum and default value is 300.

Next Page Token

Basic

A token will be returned by this endpoint if the result set is greater than the batch size and that can be passed in a subsequent call through this parameter. This can be specified as a constant value or as a combination of placeholder expressions.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Get Lead by ID

Get Lead by ID operation can be used to retrieve a single lead record through its Marketo ID.

Parameters

* marked fields are mandatory

Lead ID *

Basic

The Marketo ID of the Lead to retrieve. This should be a long value and can be specified as a constant value or as a combination of placeholder expressions.

Fields

Basic

A comma-separated list of lead fields to return. This can be specified as a constant value or as a combination of placeholder expressions.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Get Leads by Program ID

Get Leads by Program ID operation can be used to fetch a list of leads which are members of the designated program.

Parameters

* marked fields are mandatory

Program ID *

Basic

The ID of the Program to which Leads belong to. This should be an integer and can be specified as a constant value or as a combination of placeholder expressions.

Fields

Basic

A comma-separated list of lead fields to return. This can be specified as a constant value or as a combination of placeholder expressions.

Batch Size

Basic

The size of the batch to return. The maximum and default value is 300.

Next Page Token

Basic

A token will be returned by this endpoint if the result set is greater than the batch size and that can be passed in a subsequent call through this parameter. This can be specified as a constant value or as a combination of placeholder expressions.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Get Leads by List ID

Get Leads by List ID operation can be used to fetch a list of leads which are members of the given static list.

Parameters

* marked fields are mandatory

List ID *

Basic

The ID of the Static List to which Leads belong to. This should be an integer and can be specified as a constant value or as a combination of placeholder expressions.

Fields

Basic

A comma-separated list of lead fields to return. This can be specified as a constant value or as a combination of placeholder expressions.

Batch Size

Basic

The size of the batch to return. The maximum and default value is 300.

Next Page Token

Basic

A token will be returned by this endpoint if the result set is greater than the batch size and that can be passed in a subsequent call through this parameter. This can be specified as a constant value or as a combination of placeholder expressions.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "reachedSuccessDate": "string",
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Describe Leads

Describe Leads operation can be used to retrieve metadata about lead objects in the target instance, including a list of all fields available for interaction via the APIs.

Parameters

This operation does not have any configurable parameters

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "dataType": "string",
      "displayName": "string",
      "id": 0,
      "length": 0,
      "rest": {
        "name": "string",
        "readOnly": false
      },
      "soap": {
        "name": "string",
        "readOnly": false
      }
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Get Partitions

Get Partitions operation can be used to retrieve a list of available partitions in the target instance.

Parameters

This operation does not have any configurable parameters

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "description": "string",
      "id": 0,
      "name": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Is a Member of the List

Is a Member of the List operation can be used to check if a set of leads are members of a given static list.

Parameters

* marked fields are mandatory

List ID *

Basic

The ID of the Static List to which Leads belong to. This should be an integer and can be specified as a constant value or as a combination of placeholder expressions.

Define IDs in URL

Basic

If this is set to true, the lead IDs will be defined as a URL query parameter, or else they are expected to be included in the payload (refer Request section). The default value is false.

IDs to be checked *

Basic

This parameter is only applicable if Define IDs in URL parameter is set to true.

A comma-separated list that contains the IDs of the Leads to be checked. This can be specified as a constant value or as a combination of placeholder expressions.

Request

If the Define IDs in URL parameter is set to false, the request message is expected to contain the Lead IDs in a JSON payload of the following format.

{
  "input": [
    {
      "id": 0
    }
  ]
}

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "id": 0,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
In this topic
In this topic
Contact Us