Search People - Crustdata Docs

Authorizations

Authorization

string

header

required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version

enum<string>

default:2025-11-01

required

API version to use. This endpoint currently requires 2025-11-01.

Available options:

2025-11-01

Example:

"2025-11-01"

Body

application/json

Search filters, sorting, pagination, and field selection options.

Request body for /person/search. Use filters (optionally grouped with and/or), sorts, limit, and cursor pagination.

filters

object

required

Filter criteria — a single PersonSearchCondition or a PersonSearchConditionGroup combining conditions with and, or, or all_of (cross-element matching on nested-array fields).

Option 1
Option 2

Show child attributes

Example:

{
  "field": "experience.employment_details.current.title",
  "type": "=",
  "value": "CEO"
}

sorts

object[]

Sort directives applied to matched people in order.

Show child attributes

Example:

[
  {
    "field": "crustdata_person_id",
    "order": "asc"
  }
]

limit

integer

default:20

Required range: 1 <= x <= 1000

count

integer

Alias for limit.

Required range: 1 <= x <= 1000

Example:

20

cursor

string | null

Pagination cursor from a previous response's next_cursor. Omit on the first page.

Example:

"H4sIACIdzWkC..."

post_processing

object

Post-processing options applied to search results (e.g., exclusions).

Show child attributes

Example:

{
  "exclude_profiles": ["https://www.linkedin.com/in/jane-doe"],
  "exclude_names": ["Jane Doe"]
}

return_query

boolean

default:false

Debug flag - include search query in response

preview

boolean

default:false

Preview mode - return only basic fields for faster response

explain

boolean

default:false

Explain an empty result. When true and a filters-only request returns total_count 0, remarks names the condition whose removal recovers profiles. Not the search.explain flag on semantic search, which returns per-hit scoring.

Example:

true

fields

string[]

Optional list of field paths to include in each returned profile. When omitted, a default set of profile fields is returned. Use dot notation for a nested field (for example experience.employment_details.current.title) or a top-level family name (for example basic_profile) to include the whole family. Each profile always includes crustdata_person_id, even when you do not request it. A requested field with no data for the profile is null. An unsupported value returns a 400 whose metadata.available_fields lists every selectable field.

Example:

[
  "basic_profile.name",
  "experience.employment_details.current.title"
]

Response

People matching the search criteria

Paginated response from the person search endpoint containing matched profiles and pagination metadata.

profiles

object[]

required

Array of person profiles matching the search criteria

Show child attributes

Example:

[]

remarks

object[]

required

Machine-readable notes on this result. Always present, [] when there is nothing to say. Explain remarks appear only when the request set explain and the result is empty.

Show child attributes

Example:

[]

next_cursor

string | null

Opaque cursor string for fetching the next page of results. Pass this value as the cursor parameter in subsequent requests. Null when no more results are available.

Example:

"H4sIACIdzWkC_xWMMQ7DIAwAv..."

total_count

integer | null

Total number of profiles matching the search criteria across all pages

Example:

1105055

total_count_relation

string | null

Qualifier for total_count, indicating whether it is exact or a lower bound (for example eq for an exact count or gte when the true total is at least total_count). Currently returned as null.

Example:

null