Skip to main content
GET
/
searches
/
{id}
Retrieve a specific search
curl --request GET \
  --url https://app.prontohq.com/api/v2/searches/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "search": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "status": "FINISHED"
  },
  "leads": [
    {
      "lead": {
        "first_name": "<string>",
        "last_name": "<string>",
        "full_name": "<string>",
        "gender": "<string>",
        "most_probable_email": "<string>",
        "phones": [
          "<string>"
        ],
        "title": "<string>",
        "title_description": "<string>",
        "summary": "<string>",
        "linkedin_profile_url": "<string>",
        "profile_image_url": "<string>",
        "is_premium_linkedin": true,
        "connection_degree": 123,
        "status": "QUALIFIED",
        "rejection_reason": [
          "<string>"
        ],
        "lk_headline": "<string>",
        "sales_navigator_profile_url": "<string>",
        "current_positions_count": 123,
        "years_in_position": 123,
        "months_in_position": 123,
        "years_in_company": 123,
        "months_in_company": 123,
        "lk_connections_count": 123,
        "is_open_profile_linkedin": true,
        "is_open_to_work_linkedin": true,
        "most_probable_email_status": "<string>"
      },
      "company": {
        "name": "<string>",
        "cleaned_name": "<string>",
        "website": "<string>",
        "location": "<string>",
        "industry": "<string>",
        "headquarters": "<string>",
        "description": "<string>",
        "linkedin_url": "<string>",
        "employee_range": "<string>",
        "company_profile_picture": "<string>"
      }
    }
  ]
}

​
Search Status

The search object includes a status field that indicates the current state of the search operation. The possible status values are:

​
Active Statuses

  • NOT_STARTED: The search has been created but has not yet begun processing
  • ONGOING: The search is currently being processed and generating results
  • FINISHED: The search has completed successfully and all results are available

​
Error Statuses

  • RATE_LIMITED: The search was interrupted due to rate limiting constraints
  • UNAUTHORIZED: The search failed due to authentication issues
  • FORBIDDEN: The search failed due to insufficient permissions
  • ERROR: The search encountered an error during processing
When a search has a status of FINISHED, all leads are available and ready to be retrieved. For searches with error statuses, you may need to retry the search or check your API credentials and permissions.

Authorizations

​
X-API-KEY
string
header
required

Your API key

Path Parameters

​
id
string<uuid>
required

ID of the search to retrieve

Query Parameters

​
status
enum<string>

Filter leads by their qualification status

Available options:
qualified,
disqualified

Response

A search object with its leads

​
search
object
​
leads
object[]