Leads
Supported lead attributes:
Attribute | Type | Description |
---|---|---|
id | number | Unique identifier of the lead. |
creator_id | number | Unique identifier of the user who created the lead. |
owner_id | number | Unique identifier of the user who currently owns the lead. |
first_name | string | First name of the lead. |
last_name | string | Last name of the lead. Required unless organization_name field is provided. |
organization_name | string | Organization name of the lead. Required unless last_name field is provided. |
status | string | Status of the lead. |
source_id | number | Unique identifier of the Source. |
title | string | Job title of the lead. |
description | string | The lead's description. |
industry | string | Organization's industry. |
website | string | The lead's website address. |
email | string | The lead's email address. |
phone | string | The lead's phone number. |
mobile | string | The lead's mobile phone number. |
fax | string | The lead's fax number. |
twitter | string | The lead's X (formerly Twitter) handle. |
facebook | string | The lead's Facebook nickname. |
linkedin | string | The lead's Linkedin nickname. |
skype | string | The lead's Skype nickname. |
address | Address | The lead's address. For more information about the address object see Address |
tags | array | An array of tags for a lead. See more at Tag. |
custom_field_values | array | An array of custom field values for a lead. See more at Custom Field Value. |
created_at | string | Date and time that the lead was created in UTC (ISO8601 format). |
Endpoints
Stream Leads
Read the stream of lead events.
See the Firehose Overview article for more details on request and response formats and parameters.
Action
GET /v3/leads/stream
Examples
Read the stream of lead events
GET /v3/leads/stream?position=tail
Accept: application/json
Authorization: Bearer $ACCESS_TOKEN
User-Agent: $CLIENT_NAME
HTTP/1.1 200 OK
Content-Type: application/json
{
"items": [
{
"data": {
"id": 4255984,
"creator_id": 190756,
"owner_id": 190756,
"first_name": "ABC",
"last_name": "XYZ",
"organization_name": null,
"status": "New",
"source_id": 134455,
"title": "CEO",
"description": null,
"industry": null,
"website": null,
"email": null,
"phone": "1234-5677",
"mobile": null,
"fax": null,
"twitter": null,
"facebook": null,
"linkedin": null,
"skype": null,
"address": {
"country": "Poland",
"city": "KRK",
"state": "",
"postal_code": "",
"line1": "street 123"
},
"tags": [
{
"data": {
"name": "ABC",
"resource_type": "lead",
"id": 512665
},
"meta": {
"type": "tag"
}
}
],
"custom_field_values": [
{
"value": false,
"custom_field": {
"data": {
"name": "myField",
"resource_type": "lead",
"id": 29609,
"type": "bool"
},
"meta": {
"type": "custom_field"
}
}
}
],
"created_at": "2016-03-15T09:13:06Z"
},
"meta": {
"event_id": "XqEROfOwTCucD-qjE1cO6w",
"event_cause": "interaction",
"sequence": 1,
"event_type": "updated",
"previous": {
"title": "123"
},
"type": "lead",
"event_time": "2016-08-18T07:29:42Z"
}
}
],
"meta": {
"links": {
"next": "https://api.getbase.com/v3/leads/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="
},
"position": "ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==",
"top": false
}
}