Skip to content

Search Crm Entities

GET
/search/entities

Companies, contacts and deals by name, limited to what this key may see.

Authorizations

Parameters

Query Parameters

q
required
string
>= 1 characters <= 100 characters
types
Any of:
string

Comma-separated: companies,contacts,deals.

lifecycle
Any of:
string

Only records in this lifecycle stage.

limit

Results per record type.

integer
default: 10 >= 1 <= 25

Results per record type.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Search results, grouped the way the app groups them.

object
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