listPositions
Generated from the Rover tool catalog. Do not edit by hand.
Read. This tool reads Leadline data and does not change it.
List positions with location, submission counts, and status filters. Pass published: 1 for published or live jobs and published: 0 for drafts or unpublished. Pass active: 1 for open hiring and 0 for closed. Pass archived: 1 only when the user asked for archived positions. These flags are independent, and the first call must include the status the user named. Default limit is 20 — do not set limit to 100 to scan the catalog. Use when the user needs counts, location, job type, or publish dates. Prefer search-positions-tiny for id/title lookup. Omit workflowId unless the user named a workflow (never send 0). Do not send empty query strings.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| query | string | no | Free-text search |
| ids | array | no | |
| positionsIds | array | no | |
| active | 0 | 1 | no | |
| published | 0 | 1 | no | |
| archived | 0 | 1 | no | |
| workflowId | unknown | no | Filter by hiring workflow id; omit unless the user named a workflow |
| workflowIds | array | no | |
| jobType | "full-time" | "part-time" | "seasonal" | "temporary-placement" | "internship" | no | |
| cities | array | no | |
| states | array | no | |
| sort | string | no | Sort e.g. active+desc,published+desc,createdAt+desc |
| publishEndDate | string | no | Published on or before (ISO date) |
| locationsIds | array | no | Filter by location ids |
| publishStartDate | string | no | Published on or after (ISO date) |
| skip | integer | no | Pagination offset (default 0) |
| limit | integer | no | Page size (default 20) |