Get Company Search Status

GET /get-company-search-status

Check the status of a company search job using the request_id from the Search Companies endpoint.

Pricing

Free - This endpoint does not consume any credits.

Parameters

Parameter	Type	Required	Description
request_id	string	Yes	The request ID from search initiation

Example Request

cURL

curl --request GET \
  --url 'https://api.infoplug.io/get-company-search-status?request_id=search-companies-1234567890-abc123' \
  --header 'X-INFOPLUG-API-KEY: YOUR_API_KEY'

Python

import requests

url = "https://api.infoplug.io/get-company-search-status"
params = {
    "request_id": "search-companies-1234567890-abc123"
}
headers = {
    "X-INFOPLUG-API-KEY": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

Node.js

const response = await fetch(
  'https://api.infoplug.io/get-company-search-status?request_id=search-companies-1234567890-abc123',
  {
    headers: {
      'X-INFOPLUG-API-KEY': 'YOUR_API_KEY'
    }
  }
);
const data = await response.json();
console.log(data);

Example Response

200 OK

{
  "status": "completed",
  "request_id": "search-companies-1234567890-abc123",
  "progress": 100,
  "total_results": 85
}

400 Bad Request

{
  "message": "invalid_parameter",
  "parameter": "request_id",
  "details": "Request ID is required"
}

401 Unauthorized

{
  "message": "unauthorized",
  "details": "Invalid or missing API key"
}

404 Not Found

{
  "message": "not_found",
  "details": "Search request not found"
}

Status Values

Status	Description
processing	Search is in progress
completed	Search is complete, results ready
failed	Search encountered an error