Skip to main content
POST
Search Query

Authorizations

x-api-key
string
header
required

Your Sixtyfour API key.

Body

application/json

A search: one query source, or a cursor for the next page.

simple_filters
Simple Filters · object | null

Filters with Mongo-style operators ($eq, $in, $gte, $match, $and). The primary query format.

filters
Filters · object | null

JSON query DSL, for queries simple_filters cannot express, within the limits GET /search/filter-capabilities returns.

parsed_query
Parsed Query · object | null

Structured filter set returned by a previous search.

search_id
string | null

Search history ID returned by a previous search. Replays only the query shape; pass exclusions again on this request if they should apply.

Maximum string length: 200
query
string | null

Natural-language query. Cannot combine with simple_filters, filters, parsed_query or search_id.

Maximum string length: 10000
persist_history
boolean
default:true

If false, does not save the search, so its search_id cannot be replayed or exported. Default: true.

from_offset
integer | null

Company mode only: results to skip, for page-numbered navigation. Offset pages return no cursor. People mode rejects it.

Required range: 0 <= x <= 10000
cursor
string | null

Opaque pagination cursor returned by a previous response.

Maximum string length: 2048
mode
enum<string>
default:company

people or company. Taken from the saved search when you send search_id.

Available options:
people,
company
page_size
integer
default:10

Maximum results per page, 1 to 100. A page can be shorter while more results remain; rely on has_more and next_cursor.

Required range: 1 <= x <= 100
max_results
integer | null

Maximum results across all pages. Default: 1000. A value above your ceiling (GET /search/limits) is rejected.

output_shape
enum<string>
default:raw

raw returns each record as stored (raw_document_id, raw_source, raw_score); workflow returns LEAD or COMPANY rows in the shape workflow blocks use. Cursor pages keep the first page's shape.

Available options:
raw,
workflow
exclude_public_ids
string[] | null
deprecated

Deprecated. Use exclude_entity_ids. People-mode inline identifiers to exclude from results, applied as a post-filter. Accepts LinkedIn public IDs or profile URLs. For company searches, use exclude_entity_ids. Max 1000.

Maximum array length: 1000
Maximum string length: 2048
exclude_entity_ids
string[] | null

Inline identifiers to exclude from results, applied as a post-filter. People mode: LinkedIn public IDs or profile URLs. Company mode: numeric LinkedIn company IDs, company URLs/slugs, or exact website domains (values that resolve to no or multiple companies are ignored). Max 1000.

Maximum array length: 1000
Maximum string length: 2048
exclude_list_ids
string[] | null

Saved exclusion-list IDs to apply as a post-filter. Each list's entity type must match the search mode (person lists for people searches, company lists for company searches). Max 5 (10 for organizations with extended exclusion limits).

Maximum array length: 10
Maximum string length: 200
location_expansion_enabled
boolean
default:true

If true, also matches places near a location in query. Default: true.

Response

Successful Response

Response for a completed filter search.

total_results
integer
required

Rows returned so far (cumulative for company pagination).

search_id
string | null

Search history ID returned by a previous search. Replays only the query shape; pass exclusions again on this request if they should apply.

resource_handle_id
string
default:""
deprecated

Deprecated. Always empty.

csv_download_url
string | null

Signed URL to download results as CSV.

json_download_url
string | null

Signed URL to download results as JSON.

next_cursor
string | null

Cursor to fetch the next page; omitted when there are no more results.

cursor_expires_in_seconds
integer | null

Seconds until next_cursor expires.

has_more
boolean
default:false

True when another page is available via next_cursor. Always continue via the cursor; a short or empty page does NOT mean the results are exhausted.

page_size
integer | null

Maximum results per page, 1 to 100. A page can be shorter while more results remain; rely on has_more and next_cursor.

page_count
integer | null

Number of results in this response page. May be less than page_size (down to 0) while has_more is true, e.g. when exclusion filtering is active.

page_number
integer | null

1-based page number (company pagination).

total_pages
integer | null

Final total page count; omitted while has_more is true.

max_pages
integer | null

Upper bound on pages based on max_results and page_size.

max_results
integer | null

Effective maximum rows this search may return across pages after applying the request and credential limits.

remaining_results
integer | null

Rows still available under max_results after this page.

download_expires_in_seconds
integer | null

Seconds until the download URLs expire.

total_available
integer | null

Exact number of matches across pages, people mode only. Omitted when the exact count is unknown, for example when exclusions apply.

total_available_lower_bound
integer | null

Minimum total matches when the search stopped counting at its cap (50,000), so total_available is omitted. Omitted when the total is exact or no reliable lower bound is available.

charge_credits
number | null

Credits this page charged.

output_shape
enum<string>
default:raw

Shape of the rows in results.

Available options:
raw,
workflow
exported_count
integer
default:0
deprecated

Deprecated. Always 0.

results
Results · object[]

Rows returned for the current page.

parsed_query
Parsed Query · object | null

Structured filter set echoed back; round-trippable into a follow-up request.

natural_language_query
string | null

Original natural-language query echoed verbatim, if any.

unmet_constraints
string[] | null

Parsed-query fields this search could not apply.