v1

latestOpenAPI 3.0.02026-08-061021190.3 KB
Workspace

Search a workspace for a lead

Test

get/WorkspaceInboxSearch.json

Query parameters

workspace_idstring required

The workspace_id

phonestring

The leads phone number

first_namestring

The leads first name

last_namestring

The leads last_name

emailstring

The leads email address

statestring

The leads state

tagsstring

Find the leads that have a tag or set of tags use a , to seperate tags in searching on multiple tag values. Use the tag_matching to determine if and OR or AND should be used.

tag_matching'AND' | 'OR'

Use this option to determine if the tag seach should be and AND or OR

responders_onlyboolean

Return only leads that have responded

pageinteger

An integer value for what page

limitinteger

The max number of records per page

Response

successful operation