Skip to content

Leads

Read CRM leads captured across the site's inventory.

  • Base URL: /wp-json/dms/v1/
  • All requests require a Bearer API key - see Authentication.

Endpoints

Method Path Capability Purpose
GET leads view_all_leads All leads across every type (paginated, filterable).
GET leads/type/{type_id} view_all_leads Leads for a single type.
GET leads/{lead_id} view_all_leads A single lead.

All lead endpoints require the view_all_leads capability.

GET /leads

A collection of leads across every type. Accepts the standard pagination params and the collection's optional filters.

Filters (also accepted by GET /leads/type/{type_id})

Param Type Description
status string Comma-separated status slugs.
outcome string Comma-separated outcome slugs.
listing_id int Restrict to a single listing.
archived string active (default) returns non-archived leads, archived returns only archived leads, all returns both.

Each serialized lead includes archived (bool) and archived_at (datetime string, empty when active).

curl "https://your-site.com/wp-json/dms/v1/leads?page=1&per_page=25&archived=all" \
  -H "Authorization: Bearer YOUR_KEY"

GET /leads/type/{type_id}

The same collection, scoped to a single inventory type.

curl "https://your-site.com/wp-json/dms/v1/leads/type/4" \
  -H "Authorization: Bearer YOUR_KEY"

GET /leads/{lead_id}

A single lead by ID.

curl "https://your-site.com/wp-json/dms/v1/leads/987" \
  -H "Authorization: Bearer YOUR_KEY"

See also