Get an enrollment run
Returns a run’s progress and outcome. Poll it every few seconds while status is queued, fetching or running; the counters update every five people or two seconds. processed out of total is the progress, and when a run completes, enrolled plus skipped_count equals total.
total counts everyone the source yielded, including rows that could not be attempted (no email or LinkedIn handle, or past the 5,000 cap), which count as processed and skipped from the start. held_count is the part of enrolled that a rule is holding for approval. sample_skipped shows up to 50 skipped people with the reason; every refusal is also on the sequence’s refusals list, except the rows that could not be attempted.
A run that stops early keeps everyone it already enrolled. One that ends failed, for example because its worker restarted part-way, says why in error. Runs are deleted 7 days after they finish; after that this returns 404. Counts toward the Sequencer reads rate limit.
Status
queued, fetching or running. The counters update every five people or two seconds.
Reading the counters
totalcounts everyone the source yielded, including rows that could not be attempted: no email or LinkedIn handle, or past the 5,000 cap. Those count as processed and skipped from the start, soprocessedcan begin above zero.enrolledincludes people a rule is holding for approval.held_countsays how many of them there are.skipped_countcounts everyone not enrolled.sample_skippedshows up to 50 of them with the reason.truncatedis true when the source had more than 5,000 usable people, of which only the first 5,000 were considered.
failed, with an error saying to run it again for the rest. Starting a new run with the same source is safe: people already enrolled are skipped as already enrolled.
Runs are deleted 7 days after they finish. After that, this returns 404.Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Path Parameters
The run id returned when the run was started: enroll_ followed by 24 hexadecimal characters.
Response
The run.
A background enrollment run. Deleted 7 days after it finishes.
enroll_ followed by 24 hexadecimal characters.
"enroll_9c1f4e2a7b3d5c6e8f0a1b2c"
queued: waiting for a worker. fetching: reading the source; total is not known yet. running: enrolling. completed, failed and cancelled are final.
queued, fetching, running, completed, failed, cancelled 24-character hexadecimal id.
"507f1f77bcf86cd799439011"
Everyone the source yielded, including rows that cannot be attempted. 0 until the source has been read.
How many of total have been dealt with, enrolled or skipped. Progress is processed out of total.
People enrolled, including those held for approval.
People not enrolled: refused by a check, or not attemptable (no email or LinkedIn handle, or past the 5,000 cap).
Enrolled people a rule is holding for approval. Part of enrolled.
The source had more than 5,000 usable people; only the first 5,000 were considered.
Up to 50 skipped people, each with the reason. Every refusal is also on the sequence's refusals list, except rows that could not be attempted.
Why the run failed or stopped early. Absent otherwise.
When the run reached a final status. Absent while it is in progress.
What the run was pointed at. A run started from a preview keeps the preview's source and adds preview_id. Runs started in the Salesfinity app from a connected CRM have kind crm and also carry provider, scope and list_id.
A cancel has been asked for. The run stops at its next check, and status changes when it does.
When the run was started.