Schemas

Required. Elasticsearch-style query DSL for searching. Supports bool queries with filter, must, must_not, and should clauses. Use terms, match, match_phrase, exists, range, and other Elasticsearch query types.

Number of results to return (1-100)

Offset for pagination

Token for scrolling through large result sets

Array of sort specifications. Each item can specify a field and order (asc/desc). Defaults to sorting by relevance score (desc).

Required. Elasticsearch-style query DSL. Same as PersonSearchRequest query.

Number of results per page (1-100)

Page number (1-based)

Sort specifications. Defaults to relevance (_score desc).

HTTP status code

Total number of matching results

Token for pagination (if more results available)

Array of person records

Array of person records

Total number of matching results

Current page number (1-based)

Page size (results per page)

Total number of pages, computed as ceil(total / size) when total is present

Free-text or boolean search string. Supports boolean operators (AND, OR, NOT), quoted phrases for exact matches, and parentheses for grouping — e.g. ("software engineer" OR developer) AND (python OR golang) NOT intern.

Page number (1-based, max 100).

Optional session id for consistent results across paginated requests.

Current job titles, comma-separated (max 70).

Past job titles, comma-separated (max 70).

Current company URLs/IDs, comma-separated (max 50).

Past company URLs/IDs, comma-separated (max 50).

Location text, comma-separated (max 70). Defaults to United Arab Emirates when omitted.

LinkedIn Geo IDs, comma-separated (overrides locations).

School URLs/IDs, comma-separated (max 50).

First name filters, comma-separated (max 70).

Last name filters, comma-separated (max 70).

Industry IDs, comma-separated (max 70).

Seniority level IDs, comma-separated.

Job function IDs, comma-separated.

Company size filter, comma-separated.

Only people who changed jobs within 90 days.

Only people who posted on LinkedIn in the last 30 days.

LinkedIn Sales Navigator URL (overrides other filters except page).

Free-text or boolean search string. Supports boolean operators (AND, OR, NOT), quoted phrases for exact matches, and parentheses for grouping — e.g. ("software engineer" OR developer) AND (python OR golang) NOT intern.

Page number (1-based, max 100).

Optional session id for consistent results across paginated requests.

Current job titles, comma-separated (max 70).

Past job titles, comma-separated (max 70).

Current company URLs/IDs, comma-separated (max 50).

Past company URLs/IDs, comma-separated (max 50).

Location text, comma-separated (max 70). Defaults to United Arab Emirates when omitted.

LinkedIn Geo IDs, comma-separated (overrides locations).

School URLs/IDs, comma-separated (max 50).

First name filters, comma-separated (max 70).

Last name filters, comma-separated (max 70).

Industry IDs, comma-separated (max 70).

Seniority level IDs, comma-separated.

Job function IDs, comma-separated.

Company size filter, comma-separated.

Only people who changed jobs within 90 days.

Only people who posted on LinkedIn in the last 30 days.

LinkedIn Sales Navigator URL (overrides other filters except page).

Maximum number of leads to enrich with a full profile (default 10, max 25).

Find and verify email via SMTP when enriching profiles.

Skip SMTP verification when finding emails.

Include the 'About this profile' popup data.

LinkedIn profile URL.

Public identifier of the profile (the /in/ slug).

LinkedIn profile ID.

Find and verify email via SMTP.

Skip SMTP verification when finding emails.

Return only the main version with limited data for fewer credits.

Include the 'About this profile' popup data.

Unique person identifier

Elastic relevance score (_score)

Full name

First name

Last name

Middle name

Primary email address

Array of email addresses

Array of phone numbers (alternative to phone_numbers)

Array of phone numbers

Current job title

Current company name (alternative to company_name)

Current company name

Location string (e.g., 'Bengaluru, India')

Array of location names

Social media profiles (can be object or array format)

Education history

Work experience history

List of skills

List of interests

LinkedIn URL of the current company.

Company identifier for the current position.

Profile picture URL.

Whether the person has a premium account.

Whether the profile is an open profile (messageable without a connection).

Highlighted top skills.

Number of connections (profile lookups only).

Number of followers (profile lookups only).

Whether the person is open to work (profile lookups only).

Whether the person is hiring (profile lookups only).

Array of person records.

Total number of matching leads.

Current page number (1-based).

Page size.

Total number of pages.

Number of records enriched with a full profile (search-profile only).

Array with the single person record.

Unique person identifier

First name of the person

Last name of the person

Middle name of the person

Full name of the person

Email address

Phone number (E.164 format recommended)

Job title or role

Company name

Location (city, state, country, etc.)

School or university name

Array of social profile URLs (LinkedIn, Twitter, etc.)

Minimum match threshold (1-10)

Return only if match found

NinjaGraph person identifier.

First name of the person

Last name of the person

Middle name of the person

Full name of the person

Email address

Phone number (E.164 format recommended)

Job title or role

Company name

Location (city, state, country, etc.)

School or university name

Array of social profile URLs (LinkedIn, Twitter, etc.)

Minimum match threshold (1-10)

Return only if match found

Array of enrich request objects.

Array of enriched response items in request order.

HTTP status code

Match likelihood score (1-10)

Enriched person record, or null if no match found

Dataset version identifier, if applicable

Unique person identifier

Full name

First name

Middle initial

Middle name

Last initial

Last name

Sex (e.g., female, male)

Birth year

Birth date

Work email address

Personal email addresses

Recommended personal email

Mobile phone number

Full location name (e.g., city, region, country)

Locality (city)

Metro area

Region (state/province)

Country

Continent

Street address

Address line 2

Postal code

Geo coordinates (lat,lon)

When location was last updated (YYYY-MM-DD)

Phone numbers

Emails with type (e.g., professional)

Location names

Regions

Countries

Street addresses

Email address

Email type (e.g., professional, personal)

Unique person identifier

Elastic relevance score (_score)

Full name

First name

Last name

Middle name

Primary email address

Array of email addresses

Array of phone numbers (alternative to phone_numbers)

Array of phone numbers

Current job title

Current company name (alternative to company_name)

Current company name

Location string (e.g., 'Bengaluru, India')

Array of location names

Social media profiles (can be object or array format)

Education history

Work experience history

List of skills

List of interests

Social network name (e.g., linkedin, twitter, github)

Profile URL

Username on the platform

School or university name

Array of degrees obtained

Start date (YYYY-MM-DD)

End date (YYYY-MM-DD)

Job title

Start date (YYYY-MM-DD)

End date (YYYY-MM-DD), null if current position

Job description or summary

Raw job description text. The agent extracts titles, skills, location, seniority, and other hiring criteria from this.

HTTPS webhook URL that receives progress and terminal events. Must be on the allowed domain list.

Shared secret used to HMAC-SHA256-sign every webhook payload (X-Signature header).

Your reference ID. Echoed unchanged on every response and webhook event; never interpreted by the agent.

Elasticsearch index to target. Defaults to person.

Controls how deeply the agent works the query.

• false (default) — Extract criteria and generate the boolean search + Elasticsearch query only. No evaluate/optimize loop.
• true — Full reasoning mode: multiple iterations that evaluate hit results and optimize the query until confirmed.

When false, suppresses step.progress webhooks; you still receive the terminal run.completed / run.failed.

Optional tuning for the agent evaluator loop. Most relevant when agent_reasoning is true.

Unique run ID. Use for webhook correlation.

Your reference ID, echoed from the request.

Initial status after accept.

Tenant UUID to query. Required; not derived from the API key / JWT.

Range start (ISO date).

Range end (ISO date).

Optional attribute filter.

Optional job ID filter.

Tenant UUID to query. Required; not derived from the API key / JWT.

Range start (ISO date).

Range end (ISO date).

Activity rows for the requested page, ordered by sortBy/sortOrder. Empty array when nothing matches the filters.

Total matching rows across the whole date range.

Sum of units across all matching rows in the date range.

Number of pages at the requested pageSize. 0 when there are no matching rows.

Echo of the resolved page number (clamped to >= 1).

Echo of the resolved page size (clamped to 1–100).

True when a further page exists.

True when an earlier page exists.

One entry per day in the range that had activity.

Credits per attribute totalled across the whole date range.

One entry per customer. Empty when the authenticated tenant has no customers.

HTTP status code

Error message