People Search
people-searchStart a paid search to find people on X, YouTube, LinkedIn, or TikTok from a plain-language description, returning fit scores, match reasons, audience, and public contacts.
Instructions
Start a paid job billed to the user's Desearch balance: find people on X, YouTube, LinkedIn, or TikTok who match a plain-language description. Each person comes back with a fit score, why they matched, their audience, and public contacts and links. This call reserves count times the platform's per-person price (reserved_cost_usd) and returns a task_id at once. When the search ends you pay only for the people it delivered (a per-search minimum applies when it finds anyone; a search that finds no one is free) and the rest of the reservation is returned. The search runs in the background, usually for 1 to 5 minutes: poll people-search-status with the task_id to read progress and the people found so far, and use people-search-control to pause, resume, or cancel it. Do not start the same search twice; send idempotency_key so a retry returns the first task instead of charging again. Filters depend on the platform. x: min_followers, max_followers, verified_only, countries, keywords, exclude_keywords. youtube: min_subscribers, max_subscribers, countries, require_contact, keywords, exclude_keywords. linkedin: min_followers, max_followers, countries, keywords, exclude_keywords. tiktok: min_followers, max_followers, require_contact, keywords, exclude_keywords.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | No | How many qualified people to find (5-200, API default 25). The search reserves this many and bills only the people it delivers. | |
| query | Yes | Who you are looking for, in plain language, example: 'Skincare creators who review sunscreen'. | |
| exclude | No | Handles to leave out, for example people you already contacted. | |
| keywords | No | Words that should appear in their posts, videos, or bio. All platforms. | |
| metadata | No | Your own labels for this search, example: {"campaign": "q4-outbound"}. Up to 10 keys; keys are 1-40 characters of a-z, 0-9, '_', '.', '-'; values are strings of up to 200 characters. Returned on the task; filter people-search-tasks by it. The search does not use it. | |
| platform | Yes | Where to look: 'x' (X profiles), 'youtube' (YouTube creators), 'linkedin' (LinkedIn members), or 'tiktok' (TikTok creators). | |
| countries | No | Countries to prefer, example: ['US', 'GB']. x, youtube, linkedin. | |
| min_score | No | Only return people with at least this fit score (0-100). | |
| max_followers | No | Maximum follower count. x, linkedin, tiktok. | |
| min_followers | No | Minimum follower count. x, linkedin, tiktok. | |
| verified_only | No | Only verified or X Premium accounts. x only. | |
| idempotency_key | No | Any unique string for this search, for example a UUID. Sending the same key again returns the first task and is not charged again. | |
| max_subscribers | No | Maximum subscriber count. youtube only. | |
| min_subscribers | No | Minimum subscriber count. youtube only. | |
| require_contact | No | Only creators with a public email (tiktok: in the bio; youtube: an email or contact link). youtube, tiktok. | |
| exclude_keywords | No | Leave out people who mention these words. All platforms. |