Skip to main content
POST
List Enrollments

Authorizations

X-API-Key
string
header
required

Body

application/json
ids
(string | null)[] | null

Specific enrollment ids to include. Use exact enrollmentId values returned by find_mcp_enrollment, add_dynamic_action, list_enrollments, or list_flow_plan_enrollments; do not pass queueItemId here.

ignoreIds
(string | null)[] | null

Specific enrollment ids to exclude. Use exact enrollmentId values returned by find_mcp_enrollment, add_dynamic_action, list_enrollments, or list_flow_plan_enrollments; do not pass queueItemId here.

userIds
(string | null)[] | null

Assigned user ids to include. Use the exact current userId from get_current_user or userId values returned by list_team_members.

teamIds
(string | null)[] | null

Team ids to include. Example item: team_123. Use the current teamId from get_current_user; non-admin callers are still scoped to their own team.

flowPlanId
string | null

Advanced-search filter for one flow plan id.

  • Use the exact flowPlanId returned by create_flow_plan, list_flow_plans, get_flow_workspace, or add_dynamic_action.
  • Use this with statuses and finishedFrom/finishedTo for completed, failed, or canceled enrollments during a time period.
  • For a simple single-flow status list without a terminal-date range, use list_flow_plan_enrollments instead.
flowPlanIds
(string | null)[] | null

Advanced-search filter for flow plan ids.

  • Use exact flowPlanId values returned by create_flow_plan, list_flow_plans, get_flow_workspace, or add_dynamic_action.
  • For one flow plan plus a terminal-status time range, use this tool with statuses and finishedFrom/finishedTo; otherwise use list_flow_plan_enrollments for a simple one-flow status page.
statuses
enum<string>[] | null

Advanced-search status buckets to include: in_progress, completed, failed, or canceled.

  • For completed, failed, or canceled enrollments during a period, combine this with flowPlanId and finishedFrom/finishedTo; do not use from/to because they filter creation time.
  • Use list_flow_plan_enrollments for a simple one-flow status page or disqualified queue rows.
Available options:
in_progress,
failed,
completed,
canceled,
disqualified
rerunChildStatuses
enum<string>[] | null

Child rerun statuses to include.

Available options:
pending,
in_progress,
completed,
failed,
canceled
signalTypes
(enum<string> | null)[] | null

Signal types to include.

Available options:
unknown,
website_traffic,
linkedin_engagement,
leadership_changes,
champion_tracking,
job_postings,
tech_stack,
linkedin_listening,
funding,
product_usage,
empty,
company_website_traffic,
prospect_website_traffic,
general,
hiring,
null
replyTypes
enum<string>[] | null

Reply/event filters to include.

Available options:
email_reply,
meeting_booked,
linkedin_reply,
no_reply
searchQuery
string | null

Search text matched against prospect and company fields.

limit
integer
default:10

Max enrollment rows to return. Prefer the default 10; set 25 only when the customer asks for a larger page.

cursor
string | null

Cursor returned by a previous list_enrollments call.

from
string<date-time> | null

Enrollment creation timestamp lower bound in UTC. Do not use this for when an enrollment completed, failed, or was canceled; use finishedFrom instead.

to
string<date-time> | null

Enrollment creation timestamp upper bound in UTC, exclusive. Do not use this for when an enrollment completed, failed, or was canceled; use finishedTo instead.

finishedFrom
string<date-time> | null

Terminal-status timestamp lower bound in UTC, inclusive.

  • Use this for completed, failed, or canceled enrollments 'in the last N hours' or during a date range; it uses the time the enrollment entered its displayed terminal status.
  • Combine with statuses to choose an outcome.
finishedTo
string<date-time> | null

Terminal-status timestamp upper bound in UTC, exclusive.

  • Use this with finishedFrom for completed, failed, or canceled enrollments during a date range; it uses the time the enrollment entered its displayed terminal status.
  • Combine with statuses to choose an outcome.
scores
enum<string>[] | null

Lead-score buckets to include.

Available options:
perfect_fit,
good_fit,
partial_fit,
weak_fit
audienceIds
(string | null)[] | null

Audience ids to include. Use exact id values returned by list_audiences or create_audience.

sourceFlowIds
(string | null)[] | null

Source enrollment ids to include. Use exact sourceEnrollmentId/enrollmentId values returned by list_enrollments or get_flow_enrollment; do not pass queueItemId here.

firstName
string | null

Prospect first-name filter.

lastName
string | null

Prospect last-name filter.

email
string | null

Prospect email filter.

isRerun
boolean | null

When true, only rerun enrollments are included. When false, only original enrollments are included.

hasRerun
boolean | null

When set, filters enrollments that have or do not have reruns.

hasFailedAction
boolean | null

When set, filters enrollments that have or do not have failed actions.

isShowHidden
boolean | null
default:true

When true, includes hidden enrollment rows. Defaults to true to match the UI cursor-fast enrollment list.

linkedinUrl
string | null

Prospect LinkedIn URL filter.

sources
enum<string>[] | null

Enrollment source filters, such as hubspot_custom_actions.

Available options:
hubspot_custom_actions

Response

Tool result.