Skip to main content
POST
Create List
Create a new saved list. Three modes:
  1. Filters/locations — builds asynchronously from matching records. Poll GET /v1/lists/:list_id until status is "completed".
  2. Record IDs — pass up to 250 property or person IDs to create a pre-populated list synchronously. Returns with status "completed".
  3. Empty — no filters, locations, or record_ids creates an empty list.
record_ids and filters/locations are mutually exclusive — providing both returns a 400 error.
string
required
Display name for the list (1-255 characters).
string
default:"properties"
Type of records: properties or people.
array
Search filters to build the list from. Same format as property/people search.
array
Location filters. Same format as property/people search.
array
Array of property or person IDs to pre-populate the list (1-250 IDs). Cannot be combined with filters or locations.