Get Program Members

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

Returns a list of up to 300 program members on a list of values in a particular field. If you specify a filterType that is a custom field, the custom field’s dataType must be either “string” or “integer”. If you specify a filterType other than “leadId”, a maximum of 100,000 program member records can be processed by the request.

Operation ID: getProgramMembersUsingGET
Permissions: Read-Only Lead, Read-Write Lead
Request format: application/json
Returns: ResponseOfProgramMember

Parameters

Path 1

programId integer (int64) required

The id of target program.

Query 7

filterType string required

The program member field to filter on. Any custom field (string or integer types only), "updatedAt", or any searchable field. Searchable fields can be obtained via the Describe Program Member endpoint.

filterValues array of string required

A comma-separated list of values to filter on in the specified fields.

startAt string

When using filterType=updatedAt, the start of date range filter (ISO 8601-format)

endAt string

When using filterType=updatedAt, the end of date range filter (ISO 8601-format)

fields array of string

A comma-separated list of lead fields to return for each record.

batchSize integer (int32)

The batch size to return. The max and default value is 300.

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.

Responses

200 OK ResponseOfProgramMember

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 ProgramMember required

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

Model ProgramMember

seq integer (int32) required

Integer indicating the sequence of the record in response. This value is correlated to the order of the records included in the request input. Seq should only be part of responses and should not be submitted.

leadId integer (int32) required

Unique integer id of a lead record

reachedSuccess boolean required

Boolean indicating if program member has reached success criteria for program

programId integer (int32) required

Unique integer id of a program

acquiredBy boolean required

Boolean indicating if program member was acquired by program

membershipDate string required

Date the lead first became a member of the program

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": [
    {
      "seq": 123,
      "leadId": 123,
      "reachedSuccess": false,
      "programId": 123,
      "acquiredBy": false,
      "membershipDate": "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.