DIdialpad
Leads

List of Leads by Query

Get a list of Leads based on complex Queries

post/api/v2/powerdialer/lead/query

Request

  • Base URL
    https://dialpad.com
  • URL
    https://dialpad.com/api/v2/powerdialer/lead/query
  • Auth
    HTTP bearer

Query parameters

countboolean

Return a count of results instead

keys_onlyboolean

Returns only the keys from this query

totalboolean

Returns count in response header "total"

cursorstring

Cursor to resume query

offsetinteger

Return result set from this count

limitinteger

Maximum numbers of results

sourcestring

lead source filter: 'manual', 'snapshot', or 'dynamic'

include_deletedboolean

include deleted Leads

orderstring

sort column. e.g. 'first_name' or '-date_modified'

list_idstring

filter Leads on a LeadList's combined sources

static_list_idstring

filter Leads on a single StaticList.id

audience_idstring

filter Leads on a single Audience.id

csv_idstring

filter Leads on a single Csv.id

filtersstring

comma-delimited filter expressions

searchstring

substring to search relevant Lead fields by

Request body

OR

Response

Default Response

lead_idstring required
sourcestring nullable required
static_list_idstring nullable required

Changes

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