marketo op get lists

Get Marketo Lists

Version: 17.07

Supported Since: 17.07

Get Marketo Lists connector operation provides the facilities to a retrieve static list records based on given filter parameters. This connector operation provides the following sub operations.

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

Get Static Lists

Get Static Lists operation can be used to fetch a list of static lists.

Parameters

* marked fields are mandatory

Filter type

Basic

The type to filter to be applied to the Campaigns list. By default no filters are applied.

  1. Filter By List IDs - Filter the static lists by the given IDs

  2. Filter By List names - Filter the static lists by the given names

  3. Filter By Program names - Filter the static lists which are children of the designated programs

  4. Filter By Workspace names - Filter the static lists which are children of the given workspaces

List IDs *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By List IDs.

A Comma-separated list of static list IDs (as Integers) to filter the returned static lists. This can be specified as a constant value or as a combination of placeholder expressions.

List Names *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By List names.

A Comma-separated list of static list names to filter the returned static lists. This can be specified as a constant value or as a combination of placeholder expressions.

Program Names *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By Program names.

A Comma-separated list of Program names to filter the returned static lists. If set, all static lists that are children of the given programs will be returned. This can be specified as a constant value or as a combination of placeholder expressions.

Workspace Names *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By Workspace names.

A Comma-separated list of Workspace names to filter the returned static lists. If set, all static lists that are children of the given workspaces will be returned. 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": [
    {
      "createdAt": "string",
      "description": "string",
      "id": 0,
      "name": "string",
      "programName": "string",
      "updatedAt": "string",
      "workspaceName": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Get Static List by ID

Get Static List by ID operation can be used to retrieve a single static list by ID.

Parameters

* marked fields are mandatory

List ID *

Basic

The ID of the Static List to retrieve. This should be an integer and 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": [
    {
      "createdAt": "string",
      "description": "string",
      "id": 0,
      "name": "string",
      "programName": "string",
      "updatedAt": "string",
      "workspaceName": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
In this topic
In this topic
Contact Us