Person Discovery

post

https://api.smarte.pro/v2/discover/person

The Person Discover API returns a list of people that match the filters provided in the request.

Filtering supports both person and company attributes such as seniority, department, location, industry, and revenue. Filters follow AND logic across fields and OR logic within each field. Certain filters accept only predefined values. The list of supported values can be requested via [email protected].

Responses are paginated with a maximum of 100 records per page. A default sort is always applied, with support for overriding the sorting field.

The API supports following execution mode:

Preview: Returns sample results and is not charged

Body Params

Request body for the person endpoint. At least one of personFilters or companyFilters must be provided.

personFilters

object

Person-level search filters. All fields are optional; combine multiple fields to narrow results (AND logic across fields).

companyFilters

object

Company-level search filters. All fields are optional; combine multiple fields to narrow results (AND logic across fields). At least one field must be set when this object is used as companyFilters in the company endpoint.

pagination

object

Pagination configuration for result sets.

sortInfo

object

Sorting configuration. Valid sortBy values depend on the endpoint (see endpoint documentation). Only a single field can be specified.

suppression

object

Suppression list configuration. When enabled, records whose identifiers appear in the specified lists are excluded from the response and counted in totalSuppressed. List IDs must be prefixed with the matching endpoint scope: person_ for the person endpoint, company_ for the company endpoint.

maxRecords

integer

Maximum total records to return across all pages. The absolute ceiling is 10,000. Must be greater than 0 if provided.

Headers

output-mode

string

enum

Defaults to preview

Controls the response shape. - preview (default) — returns a slim record with essential fields only.

Allowed:

apikey

string

required

API key issued by SMARTe. Pass in the apikey request header.

Responses

200Successful response — person records with optional company context.

400Bad Request — one or more request fields are missing or invalid.

401Unauthorized — apikey header is missing, blank, or invalid.

404Not Found — stats query returned zero results, or a suppression list ID does not exist.

409Conflict — a suppression list ID's scope does not match the endpoint (e.g. a person_ list ID used on the company endpoint).

429Too Many Requests — rate limit exceeded.

500Internal Server Error.