Get Leads by Program Id¶

GET /rest/v1/leads/programs/{programId}.json

Permissions Read-Only LeadRead-Write Lead

Method: GET
Path: /rest/v1/leads/programs/{programId}.json
Tag: Leads
Operation ID: getLeadsByProgramIdUsingGET

Retrieves a list of leads which are members of the designated program. Required Permissions: Read-Only Lead, Read-Write Lead

Formats¶

Request: application/json
Response: application/json

Request¶

Path parameters¶

Name	Type	Required	Description	Constraints
`programId`	integer (int32)	Yes	The id of the program to retrieve from

Query parameters¶

Name	Type	Required	Description	Constraints
`fields`	array	No	A comma-separated list of fields to be returned for each record	collection format: multi
`batchSize`	integer (int32)	No	The batch size to return. The max and default value is 300.
`nextPageToken`	string	No	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.

Example request¶

GET {{base_url}}/rest/v1/leads/programs/{{programId}}.json?fields={{fields}}&batchSize={{batchSize}}&nextPageToken={{nextPageToken}}
Accept: application/json

Responses¶

200 — OK¶

Schema: model: ResponseOfLead

Generated example¶

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

Referenced models¶

ResponseOfLead

Source¶

Generated from swagger-mapi.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.