Skip to main content
GET
Search contacts

Authorizations

Authorization
string
header
required

Use an existing fmk_ API key from Settings → Integrations or an fmo_ OAuth access token.

Query Parameters

locationId
string

Required for agency keys. Ignored for a location key, which stays pinned to its own CRM location. A foreign or transferred-out location is refused; the read does not run against that location.

Required string length: 1 - 64
query
string
required
Required string length: 2 - 200
limit
integer
default:10
Required range: 1 <= x <= 20

Response

Successful read

data
any
required
requestId
string
required
Pattern: ^req_