GET
/
v1
/
leads
/
:id
/
retrieve
curl --location --request GET 'https://api.stateset.com/v1/leads/retrieve' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
}'

{
  "id": "<string>",
  "assistant": "<string>",
  "assistant_phone": "<string>",
  "avatar": "<string>",
  "birthdate": "<string>",
  "controller": "<string>",
  "created_at": {},
  "created_by": "<string>",
  "department": "<string>",
  "description": "<string>",
  "do_not_call": true,
  "email": "<string>",
  "email_opt_out": true,
  "fax": "<string>",
  "fax_opt_out": true,
  "firstName": "<string>",
  "handle": "<string>",
  "invalid_lead": true,
  "languages": "<string>",
  "lastName": "<string>",
  "last_modified_by": "<string>",
  "leadSource": "<string>",
  "mailingCity": "<string>",
  "mailingCountry": "<string>",
  "mailingGeocodeAccuracy": "<string>",
  "mailingState": "<string>",
  "mailingStreet": "<string>",
  "owner": "<string>",
  "phone": "<string>",
  "photoUrl": "<string>",
  "processor": "<string>",
  "title": "<string>"
}

​
Body

​
id
text
required
The ID of the user group to which the lead belongs.

​
Response

​
id
text
The ID of the lead.
​
assistant
text
Name or details of the assistant associated with the lead.
​
assistant_phone
text
Phone number of the assistant.
​
avatar
text
URL or path to the lead’s avatar image.
​
birthdate
text
Date of birth of the lead.
​
controller
text
Name or details of the controller associated with the lead.
​
created_at
datetime
Date and time when the lead was created.
​
created_by
text
Name or details of the person who created the lead.
​
department
text
Department or division associated with the lead.
​
description
text
Description or additional details about the lead.
​
do_not_call
boolean
Indicates whether the lead should not be called.
​
email
text
Email address of the lead.
​
email_opt_out
boolean
Indicates whether the lead has opted out of email communication.
​
fax
text
Fax number of the lead.
​
fax_opt_out
boolean
Indicates whether the lead has opted out of fax communication.
​
firstName
text
First name of the lead.
​
handle
text
Handle or username associated with the lead.
​
invalid_lead
boolean
Indicates whether the lead is marked as invalid.
​
languages
text
Languages known or spoken by the lead.
​
lastName
text
Last name of the lead.
​
last_modified_by
text
Last person who modified the lead.
​
leadSource
text
Source or origin of the lead/lead.
​
mailingCity
text
City of the mailing address.
​
mailingCountry
text
Country of the mailing address.
​
mailingGeocodeAccuracy
text
Geocoding accuracy of the mailing address.
​
mailingState
text
State or province of the mailing address.
​
mailingStreet
text
Street of the mailing address.
​
owner
text
Name or details of the owner of the lead.
​
phone
text
Phone number of the lead.
​
photoUrl
text
URL or path to the lead’s photo.
​
processor
text
Name or details of the processor associated with the lead.
​
title
text
Title or position of the lead.
curl --location --request GET 'https://api.stateset.com/v1/leads/retrieve' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
}'