Get Lead Details

get

https://{host}/v2/leads

Retrieves the details of leads created in an org. You can use filter parameters to get personalized results.

Query Params

userId

string

Get leads of a specific customer. Pass the user ID of the customer.

status

string

Get leads of a specific status. Values: OPEN, ON_HOLD, WON, LOST, DELETED.

substatus

string

Get leads by lead sub-status.

owner

string

Fetch leads assigned to a specific associate. Pass the associate/staff ID (user id of the staff).

limit

string

Limit the number of results to retrieve.

offset

string

Number of rows (as per the data entered into the table) that you want omit from showing.

entityType

string

Get leads of a specific entity. You also need to pass the entityCode accordingly. Pass entityType and e Values: ZONE, CONCEPT, STORE, TILL, STR_SERVER, ADMIN_USER, ASSOCIATE, STAFF.

entityCode

string

Pass the code of the respective entityType. For example, if entityType is STORE, then entityCode should be store code by which you want to get leads.

Responses

Language

Credentials

Basic

base64

URL

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400