List shortlists
https://api.vamotalent.ai/v2/shortlistsshortlist:readYour account shortlists with derived member counts. Excludes archived unless archived=true.
Query parameters
limitinteger default: 25min 1, max 250offsetinteger | null default: 0min 0, max 100000archivedstringtruefalsepinnedstringtruefalse
Responses
The shortlists
rowsarray of Shortlist requiredThis page of shortlists.
idstring requiredThe shortlist id.
namestring requiredThe list name.
kindstring requiredWhat kind of list this is: `project` for a list linked to a project you can read, `freestanding` for every other list. Seeing `project` needs project:read: without it a list linked to a project reads `freestanding` like any other. An API key or a connected AI client does not hold project:read.
freestandingprojectpipelinedescriptionstring | null requiredFree-text description. Null when none.
ownerIdstring | null requiredThe member or API key that owns the list, as an actor id. Null when it has no individual owner.
pinnedboolean requiredWhether the list is pinned for quick access.
archivedAtstring | null requiredWhen the list was archived, as an ISO 8601 instant. An archived list is hidden from the default listing but keeps its members and sequences. Null while active.
createdAtstring requiredWhen the list was created, as an ISO 8601 instant.
agentIdstring | null requiredThe managed agent that owns this list, when one does. The list is yours either way; this only says who keeps it up to date.
statsobject requiredMember and sequence counts for this list.
membersinteger requiredHow many contacts are on this list.
sequencesinteger requiredHow many outreach sequences are attached to it.
totalinteger requiredHow many shortlists match the filters in total, not just on this page.