Screener
Run Screener
Execute a saved screener and get matching results
POST
Execute a previously saved screener query and return the matching companies or GST records.
This endpoint runs the saved FQL query in real-time against the latest data. Results are not cached — you always get fresh data.
Path Parameters
The ID of the saved screener to execute
Headers
Bearer token:
Bearer <access_token>Query Parameters
Page number for pagination
Number of results per page (max 100)
Response
Array of matching company or GST records
Total number of matching records
Current page number
Results per page
Screener metadata (id, name, type, query)
Error Codes
| Status | Description |
|---|---|
| 200 | Screener executed successfully |
| 401 | Unauthorized — invalid or expired token |
| 404 | Screener not found or doesn’t belong to user |
| 422 | Invalid query — FQL syntax error in saved screener |
| 429 | Rate limit exceeded |