API reference

Get a scoring job

A scoring preview or apply that is still re-scoring everyone (a job_id from preview_scoring or apply_scoring): its status, and its result once status is done. status is queued, running, done or failed. result is what preview_scoring or apply_scoring would have answered; error is set when it failed, and code busy means Revcenter was busy and nothing changed: ask again. wait_seconds (0 to 25) waits for the job to finish before answering. Does not use credits.

Needs scope searches:read.

GET

searches

{searchId}

scoring

jobs

{jobId}

Get a scoring job

curl --request GET \
  --url https://api.revcenter.ai/v1/searches/{searchId}/scoring/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.revcenter.ai/v1/searches/{searchId}/scoring/jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revcenter.ai/v1/searches/{searchId}/scoring/jobs/{jobId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": {
    "job_id": "2f1c9a4e-7b3d-5e21-9c4a-8d1e6f0b3a72",
    "kind": "preview",
    "search_id": "0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61",
    "status": "done",
    "result": {
      "shortlistBefore": 14,
      "shortlistAfter": 19,
      "added": 5,
      "removed": 0
    },
    "error": null,
    "created_at": "2026-10-26T22:00:00.000Z",
    "finished_at": "2026-10-26T22:00:21.000Z"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

Authorizations

Authorization

string

header

required

An API key from Settings → Integrations → API (rvc_live_…).

Path Parameters

searchId

string

required

A search id

jobId

string

required

A scoring job id

Query Parameters

wait_seconds

integer

Wait up to this many seconds (0 to 25) for the job to finish before answering. Default 0.

Response

data

any

meta

object

Show child attributes

Get a scoring job

curl --request GET \
  --url https://api.revcenter.ai/v1/searches/{searchId}/scoring/jobs/{jobId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.revcenter.ai/v1/searches/{searchId}/scoring/jobs/{jobId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revcenter.ai/v1/searches/{searchId}/scoring/jobs/{jobId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "data": {
    "job_id": "2f1c9a4e-7b3d-5e21-9c4a-8d1e6f0b3a72",
    "kind": "preview",
    "search_id": "0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61",
    "status": "done",
    "result": {
      "shortlistBefore": 14,
      "shortlistAfter": 19,
      "added": 5,
      "removed": 0
    },
    "error": null,
    "created_at": "2026-10-26T22:00:00.000Z",
    "finished_at": "2026-10-26T22:00:21.000Z"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

{
  "error": {
    "code": "search_not_found",
    "message": "No search with that id in this workspace.",
    "details": null,
    "request_id": "req_01JABCDEF"
  },
  "meta": {
    "request_id": "req_01JABCDEF"
  }
}

Get started

Concepts

Tools

Guides

Recipes

Use cases

API reference

Get a scoring job

Authorizations

Path Parameters

Query Parameters

Response