Skip to content

List Searchable Fields

GET
/contacts/searchable-fields

Which fields can be searched, and what each one COSTS.

Every entry carries a tier derived from the org’s real indexes - fast, text_search or full_scan - plus the operators that column’s live type supports. Index coverage is per-org, so this is the only honest way to know a custom-column search is a full table scan before running it.

Authorizations

Parameters

Query Parameters

entity_type

contact or company. Anything else is refused.

string
default: contact

contact or company. Anything else is refused.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string