Skip to main content

LeadFilterResponseDTO

Lead summary row returned by POST /v1/open-api/lead/filter. Does not include attribution / channel / UTM data nor contacts/fields — the full lead detail is available via GET /v1/open-api/lead/{leadId}.

idint64

Lead ID

Example: 1001
uuiduuid

Lead UUID value

Example: 550e8400-e29b-41d4-a716-446655440000
facebookLeadIdstringnullable

Identifier of the originating Facebook Lead Ads lead. Set only for leads created from a Facebook lead form; null for every other source.

Example: 1234567890123456
namestring

Lead name

Example: New apartment buyer
balancedouble

Balance (budget) amount — currency is currency.

Example: 5000
currency objectnullable

Lead's currency. null when the lead has no currency set.

idint32

Currency ID

Example: 1
valuedouble

Exchange rate (1 for the basic currency)

Example: 1
updateTimestampint64

Last update time (epoch seconds)

Example: 1672531200
basicboolean

Whether it's the company's basic currency

Example: true
ccystring

Currency code

Example: USD
pipeStatus object

Compact reference to a pipeline (funnel) status, embedded in LeadDTO and LeadFilterResponseDTO as pipeStatus.

idint64

Pipeline status ID

Example: 979
namestring

Pipeline status name

Example: New
pipeIdint64

The pipe (funnel) this status belongs to

Example: 12
pipeNamestring

Pipe (funnel) name

Example: Sales
responsibleBy object

Responsible employee — filter with responsibleByIds.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
createdBy object

Employee who created the lead — filter with createdByIds.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
updatedBy object

Compact employee reference.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
deletedBy objectnullable

Employee who deleted the lead — pairs with deletedTimestamp. null when not deleted.

idint32

Employee ID

Example: 201
fullNamestring

Employee full name

Example: David Wilson
tagsstring[]
Example: ["VIP","New"]
createdTimestampint64

Creation time (epoch seconds) — filter with createdTimestampFrom/createdTimestampTo.

Example: 1672531200
updatedTimestampint64

Last update time (epoch seconds) — filter with updatedTimestampFrom/updatedTimestampTo and sort with UPDATED_TIMESTAMP.

Example: 1672704000
deletedTimestampint64nullable

Deletion time (epoch seconds); null when the lead is not deleted.

Example: null
deletedboolean

true when the lead is soft-deleted.

Example: false
currencyIdint32nullabledeprecated

Deprecated — use currency.id.

Example: 1
pipeStatusIdint64deprecated

Deprecated — use pipeStatus.id.

Example: 1
responsibleByIdint32nullabledeprecated

Deprecated — use responsibleBy.id.

Example: 101
responsibleByNamestringnullabledeprecated

Deprecated — use responsibleBy.fullName. The old plain-text responsibleBy value.

Example: Alice Johnson
LeadFilterResponseDTO
{
  "id": 1001,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "facebookLeadId": "1234567890123456",
  "name": "New apartment buyer",
  "balance": 5000,
  "currency": {
    "id": 1,
    "value": 1,
    "updateTimestamp": 1672531200,
    "basic": true,
    "ccy": "USD"
  },
  "pipeStatus": {
    "id": 979,
    "name": "New",
    "pipeId": 12,
    "pipeName": "Sales"
  },
  "responsibleBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "createdBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "updatedBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "deletedBy": {
    "id": 201,
    "fullName": "David Wilson"
  },
  "tags": [
    "VIP",
    "New"
  ],
  "createdTimestamp": 1672531200,
  "updatedTimestamp": 1672704000,
  "deletedTimestamp": null,
  "deleted": false
}