Get Programs by Lead Id

GET /rest/v1/leads/{leadId}/programMembership.json

Query program membership for one lead.

Operation ID: getProgramMembershipUsingGET
Permissions: Read-Only Asset
Request format: application/json
Returns: ResponseOfPrograms

Parameters

Path 1

leadId integer (int64) required

The Marketo lead id

Query 6

nextPageToken string

A token will be returned by this endpoint if the result set is greater than the batch size and can be passed in a subsequent call through this parameter. See Paging Tokens for more info.

batchSize integer (int32)

Maximum number of records to return. Maximum and default is 300.

earliestUpdatedAt string

Exclude programs prior to this date. Must be valid ISO-8601 string. See Datetime field type description.

latestUpdatedAt string

Exclude programs after this date. Must be valid ISO-8601 string. See Datetime field type description.

filterType string

Set to "programId" to filter a set of programs.

filterValues array of string

Comma-separated list of program ids to match against

Responses

200 OK ResponseOfPrograms

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

moreResult boolean

Boolean indicating if there are more results in subsequent pages

nextPageToken string

Paging token given if the result set exceeded the allowed batch size

requestId string required

Id of the request made

result array of Program required

Array of results for individual records in the operation, may be empty

Model Program

id integer (int64) required

Unique integer id of a program record

acquiredBy boolean required

Whether the lead was acquired by the parent program

isExhausted boolean required

Whether the lead is currently exhausted in the stream, if applicable

membershipDate string required

Date the lead first became a member of the program

nurtureCadence string

Cadence of the parent stream if applicable

progressionStatus string required

Program status of the lead in the parent program

reachedSuccess boolean required

Whether the lead is in a success-status in the parent program

stream string

Stream that the lead is a member of, if the parent program is an engagement program

updatedAt string required

Datetime when the program was most recently updated

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "id": 123,
      "acquiredBy": false,
      "isExhausted": false,
      "membershipDate": "string",
      "nurtureCadence": "string",
      "progressionStatus": "string",
      "reachedSuccess": false,
      "stream": "string",
      "updatedAt": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.