Create List

Create a new saved list. Three modes:

Filters/locations — builds asynchronously from matching records. Poll GET /v1/lists/:list_id until status is "completed".
Record IDs — pass up to 250 property or person IDs to create a pre-populated list synchronously. Returns with status "completed".
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.

body namestringrequired

Display name for the list (1-255 characters).

body source_typestringdefault: properties

Type of records: properties or people.

body filtersarray

Search filters to build the list from. Same format as property/people search.

body locationsarray

Location filters. Same format as property/people search.

body record_idsarray

Array of property or person IDs to pre-populate the list (1-250 IDs). Cannot be combined with filters or locations.

Response example

1234567891011121314{
  "data": {
    "list_id": "abc-123-def-456",
    "name": "High Value Properties in Miami",
    "source_type": "properties",
    "build_type": "prospect",
    "status": "building",
    "total_count": 0,
    "progress": 0,
    "estimated_count": 45230,
    "created_at": "2026-02-18T14:30:00Z",
    "updated_at": "2026-02-18T14:30:00Z"
  }
}