Retrieve a talent search
The search's status and, once it has finished, its ranked matches (at most 50): who they are, how well their resumes cover the job's must-have and important requirements, a short reason, and any report that already exists for them and this job. Matches are suggestions from resumes already in Probb, not analyses. Create a report with POST /v1/reports to analyse one. The key also needs candidates:read.
Required scope: jobs:read (jobs:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
talent_search_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>id*stringThe talent search's ID.
1 <= length <= 200Success.
application/json- response
object*stringid*stringThe search's ID. The same ID the app uses.
job*The job the candidates were searched for.
status*stringqueued, then preparing, retrieving, evaluating and finalizing while it runs, then completed. partial finished but could not assess every shortlisted candidate; its matches are usable. failed produced nothing.
"queued""preparing""retrieving""evaluating""finalizing""completed""partial""failed"done*booleanWhether the search has stopped, successfully or not.
counts*errorMessage*|Why the search failed, when it did.
createdAt*stringWhen the search was started.
date-timecompletedAt*|When it stopped.
matches*array<>Matches, closest first. Empty while the search runs. At most 50.
totalMatches*integerThe number of matches.
-9007199254740991 <= value <= 9007199254740991# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/talent-searches/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"{ "object": "talent_search", "id": "string", "job": { "id": "string", "title": "string" }, "status": "queued", "done": true, "counts": { "pool": -9007199254740991, "retrieved": -9007199254740991, "shortlisted": -9007199254740991, "evaluated": -9007199254740991, "matched": -9007199254740991, "failed": -9007199254740991 }, "errorMessage": "string", "createdAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z", "matches": [ { "rank": -9007199254740991, "band": "strong_potential", "candidate": { "id": "string", "name": "string", "currentRole": "string", "location": "string" }, "mustHave": { "met": -9007199254740991, "partial": -9007199254740991, "total": -9007199254740991 }, "important": { "met": -9007199254740991, "partial": -9007199254740991, "total": -9007199254740991 }, "highlight": "string", "report": { "id": "string", "completed": true } } ], "totalMatches": -9007199254740991}