Search stops
search_stopsSearch all assigned and unassigned stops by keyword or SQL-like filters, then sort and page through results by route, date, state, address, recipient, or barcode.
Instructions
Full-text search across all stops (assigned and unassigned) within the team's data retention, by keyword and/or the API's filter language, e.g. deliveryInfo.state = "failed_not_home" and createdAt >= "2026-09-01T00:00:00Z" or address.address ~= "Bristol". Filterable fields include planId, routeId, type, activity, notes, address., recipient.name/email/phone/externalId, deliveryInfo.state/attempted/succeeded/attemptedAt, orderInfo., barcodes, packageLabel, createdAt, arrivalAt and customProperties.. String comparisons with >, >=, <, <= work on ISO-8601 dates only. The search index lags the live data slightly, so a stop created seconds ago may not be found yet.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Filter expression in Spoke's SQL-like syntax (sent as-is, the API validates it) | |
| keyword | No | Keywords, fuzzy-matched across the stops' text fields | |
| page_token | No | next_page_token from a previous call, to continue the same list | |
| sort_field | No | Sort field; relevance when omitted | |
| sort_order | No | Sort direction (the API's default is asc) | |
| max_results | No | Minimum number of records to return; whole pages are returned, so a few more may come back | |
| include_contact_details | No | Include recipient details, full addresses, proof-of-delivery links, tracking links and unredacted notes |