CRM Pipeline

List CRM leads

get/api/v1/leads/crm

Request

  • Base URL: https://www.cysora.com
  • URL: https://www.cysora.com/api/v1/leads/crm
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

agentIdstring

Only leads captured by this agent.

stage'new' | 'contacted' | 'qualified' | 'won' | 'lost'

Only leads in this pipeline stage.

ownerIdstring

Only leads owned by this member id.

channelstring

Only leads from this source channel, e.g. 'web'.

tagstring

Only leads carrying this tag/segment.

followupDue'overdue' | 'today' | 'week' | 'none' | 'any'

Filter by follow-up due window: overdue, today, this week, none set, or any set.

searchstring

Match against contact name, email, phone, or company.

addedFromstring

Only leads added to the CRM on or after this UTC date (YYYY-MM-DD).

addedTostring

Only leads added to the CRM on or before this UTC date (YYYY-MM-DD).

archived'open' | 'closed' | 'all'

Which leads to include: open (not archived, default), closed (archived only), or all.

band'hot' | 'warm' | 'cool' | 'cold'

Only leads in this score band.

minScoreinteger nullable

Only leads scored at or above this value.

minValuenumber nullable

Only leads with a parsed deal value at or above this amount.

payment'paid' | 'balance_due' | 'awaiting' | 'any'

Take payment: paid in full, balance due (link sent or partly paid), waiting on the owner's price, or any payment activity.

sort'latest' | 'oldest' | 'score_desc' | 'score_asc' | 'value_desc'

Sort order: latest (default, by CRM-added timestamp) | oldest | score_desc | score_asc | value_desc.

limitinteger

Page size (default 20, max 100).

offsetinteger nullable

Rows to skip after sorting.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.