Skip to main content
POST
Search people

Authorizations

x-metal-client-id
string
header
default:<client-id>
required

The Client ID of your API key.

x-metal-api-key
string
header
default:<api-key>
required

The secret value of your API key.

Query Parameters

page
integer
default:1

Page number, starting at 1. The deep offset (page - 1) * limit cannot exceed 10,000.

Required range: x >= 1
limit
integer
default:100

Results per page. The maximum supported page size is 400.

Required range: 1 <= x <= 400

Body

application/json

Search text, structured filters, and ranking options. Pass pagination through the page and limit query parameters.

text
string

Free-text query ranked against the resource's searchable fields.

Example:

"industrial automation suppliers"

filters
object

Structured predicates grouped with and and or.

sort
object[]

Ordered sort fields.

hybrid
boolean
default:false

Enables hybrid semantic and keyword ranking on endpoints that support it.

fuzzy
boolean
default:false

Enables approximate text matching on supported keyword-search paths. Document search and company hybrid search ignore this flag; activity search uses it only when fullText is false.

fullText
boolean
default:false

Enables word-level matching on endpoints that support it.

Response

Ranked people results.

data
object[]
metadata
object

Pagination details returned by search endpoints.