Skip to main content
GET
/
leads
/
{leadId}
cURL
curl --request GET \
  --url https://api.attent.app/v1/leads/{leadId} \
  --header 'x-api-key: <api-key>'
{
  "id": "room_abc",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+15555555555",
  "email": "john.doe@example.com",
  "customerProfile": "My Customer Profile",
  "additionalInfo": {
    "key1": "value1",
    "key2": "value2"
  },
  "createdAt": "2024-05-17T21:09:13Z",
  "updatedAt": "2024-05-18T10:30:00Z",
  "hasReplied": true,
  "isHot": true,
  "isQualified": false,
  "isUnsubscribed": false,
  "isAiOn": true,
  "tags": [
    {
      "id": "tag1",
      "name": "Tag 1",
      "condition": "Condition 1"
    },
    {
      "id": "tag2",
      "name": "Tag 2",
      "condition": "Condition 2"
    }
  ],
  "summary": "Summary of the conversation with the lead.",
  "externalLeadId": "00Q5g00000ABCDEAA1"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
leadId
string
required

The ID of the lead to fetch

Response

Lead details fetched successfully.

​
id
string

Stable unique identifier for the lead.

​
firstName
string

The first name of the lead.

​
lastName
string

The last name of the lead.

​
phone
string

The phone number of the lead. This will be in the format +15555555555.

​
email
string

The email address of the lead, if available.

​
customerProfile
string

The name of the customer profile to which this lead belongs.

​
createdAt
string<date-time>

The date and time when the lead was created.

​
updatedAt
string<date-time>

The date and time when the lead was last modified. Useful for cache freshness checks.

​
additionalInfo
object

An optional key-value object containing additional information stored with the lead. This includes any context from when the lead was created, along with any variables that Apten has stored for the lead.

​
hasReplied
boolean

Indicates whether the lead has replied to any messages from Apten.

​
isHot
boolean

Indicates whether the lead is considered "hot" by Apten.

​
isQualified
boolean

Indicates whether the lead is considered "qualified" by Apten.

​
isUnsubscribed
boolean

Indicates whether the lead has unsubscribed from Apten.

​
isAiOn
boolean

Indicates whether Apten is turned on for the lead.

​
tags
object[]

An array of tags associated with the lead.

​
summary
string

A summary of the conversation with the lead.

​
externalLeadId
string

The ID of the lead in an external CRM (Salesforce, HubSpot, Dynamics, or Close), if the lead is linked to one.