Count leads - Autotouch AI

This page documents the canonical HTTP contract for this endpoint.

Body parameters

filter · optional
object
Optional FilterDescriptor; same root rule/group validation as POST /api/leads/query.
search · optional
string
Optional free-text query.
sort · optional
array<object>
Accepted by shared request model but ignored by count.
pagination · optional
object
Accepted by shared request model but ignored by count.
scope · optional
string
Optional org or user scope.
source_table_id · optional
string
Optional research table context.
source_table_scope · optional
string
company or lead; defaults to company.
related_tables_mode · optional
string
Accepted by shared request model but ignored by count.
include_research_data · optional
boolean
Accepted by shared request model but ignored by count.
include_placeholder_leads · optional
boolean
Include or exclude placeholder Leads in matching; defaults false.
selection_context · optional
string
Accepted by shared request model but ignored by count.
ids_only · optional
boolean
Accepted by shared request model but ignored by count.
include_count · optional
boolean
Accepted by shared request model; count is always returned.

Name	Type	Description
filter	object	Optional FilterDescriptor; same root rule/group validation as POST /api/leads/query.
search	string	Optional free-text query.
sort	array<object>	Accepted by shared request model but ignored by count.
pagination	object	Accepted by shared request model but ignored by count.
scope	string	Optional org or user scope.
source_table_id	string	Optional research table context.
source_table_scope	string	company or lead; defaults to company.
related_tables_mode	string	Accepted by shared request model but ignored by count.
include_research_data	boolean	Accepted by shared request model but ignored by count.
include_placeholder_leads	boolean	Include or exclude placeholder Leads in matching; defaults false.
selection_context	string	Accepted by shared request model but ignored by count.
ids_only	boolean	Accepted by shared request model but ignored by count.
include_count	boolean	Accepted by shared request model; count is always returned.

Errors

Status	Meaning
400	Invalid descriptor payload.
401	Invalid API key or missing auth.
403	Missing leads:read scope.
503	Lead count timed out; refine the filter and retry.

Example

bash

curl -X POST "https://app.autotouch.ai/api/leads/query/count" \
    -H "Authorization: Bearer stk_your_key_id.your_secret" \
    -H "Content-Type: application/json" \
    -d '{"scope":"org"}'

Request body

json

{
    "filter": {
      "root": {
        "kind": "rule",
        "field": "lead_status",
        "operator": "eq",
        "value": "new"
      }
    },
    "scope": "org"
  }

Response example

json

{
    "count": 184
  }