API reference

List every record a search returned

Every person a search’s result pages listed, read or not, in the order returned: each with what became of them (scored, known, not_read), the score if scored, and the read profile when this workspace holds one. list_people and the shortlist hold only the people a search scored; this is everyone it found, one record per person (the page that listed them first wins). scored: read and scored in this search. known: already in this workspace from another search, so not read again. not_read: listed but never read (screened out, left for a later round, or the search stopped). candidate_id and profile are null for people this workspace has not read. A database-only search returns no records. For every search in a project at once, use list_project_records; for everyone across the workspace, list_candidates. No contact details. Does not use credits.

Needs scope shortlists:read.

GET

searches

{searchId}

records

List every record a search returned

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

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

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

{
  "data": [
    {
      "candidate_id": "3c2b1a09-8f7e-4d6c-9b5a-4e3d2c1b0a99",
      "status": "scored",
      "score": 91,
      "page": 1,
      "linkedin_url": "https://www.linkedin.com/in/example",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "title": "Plant Controller",
      "company": "Garden State Foods",
      "location": "Cherry Hill, NJ",
      "summary": "Plant controller in food manufacturing.",
      "open_profile": true,
      "premium": false,
      "profile": null
    },
    {
      "candidate_id": null,
      "status": "not_read",
      "score": null,
      "page": 3,
      "linkedin_url": "https://www.linkedin.com/in/example-2",
      "first_name": "Sam",
      "last_name": "Ortiz",
      "title": "Assistant Controller",
      "company": "Delaware Valley Packaging",
      "location": "Cherry Hill, NJ",
      "summary": null,
      "open_profile": false,
      "premium": false,
      "profile": null
    }
  ],
  "cursor": null,
  "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 → Usage → API (rvc_live_…).

Path Parameters

searchId

string

required

A search id

Query Parameters

profile

enum<string>

false to leave profiles out

Available options:

false

limit

integer

Up to 500 per page (default 100; 50 for projects).

cursor

string

The cursor from the previous page. Omit for the first page.

Response

data

object[]

Show child attributes

cursor

string | null

Pass as ?cursor= for the next page; null on the last.

meta

object

Show child attributes

List every record a search returned

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

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

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

{
  "data": [
    {
      "candidate_id": "3c2b1a09-8f7e-4d6c-9b5a-4e3d2c1b0a99",
      "status": "scored",
      "score": 91,
      "page": 1,
      "linkedin_url": "https://www.linkedin.com/in/example",
      "first_name": "Dana",
      "last_name": "Whitfield",
      "title": "Plant Controller",
      "company": "Garden State Foods",
      "location": "Cherry Hill, NJ",
      "summary": "Plant controller in food manufacturing.",
      "open_profile": true,
      "premium": false,
      "profile": null
    },
    {
      "candidate_id": null,
      "status": "not_read",
      "score": null,
      "page": 3,
      "linkedin_url": "https://www.linkedin.com/in/example-2",
      "first_name": "Sam",
      "last_name": "Ortiz",
      "title": "Assistant Controller",
      "company": "Delaware Valley Packaging",
      "location": "Cherry Hill, NJ",
      "summary": null,
      "open_profile": false,
      "premium": false,
      "profile": null
    }
  ],
  "cursor": null,
  "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

List every record a search returned

Authorizations

Path Parameters

Query Parameters

Response