API reference

List every record a project's searches returned

Every person any of a project’s searches returned, expansions included, once each in the order returned: status rolled up across the searches (scored, known, not_read), the best score, which searches returned them, and the read profile when this workspace holds one. One record per person across the project (the earliest listing wins), with the same fields as list_search_records plus first_search_id (the search that listed them first) and search_ids (every search in the project that returned them). status is scored when any of the project’s searches scored them, else known when this workspace already holds them, else not_read; score is the best any of the project’s searches gave. For everyone across the whole workspace, use list_candidates. No contact details. Does not use credits.

Needs scope shortlists:read.

GET

projects

{projectId}

records

List every record a project's searches returned

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

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

fetch('https://api.revcenter.ai/v1/projects/{projectId}/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,
      "first_search_id": "0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61",
      "search_ids": [
        "0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61",
        "7d2e4f1a-0c3b-4a5d-9e8f-6b1c2d3e4f52"
      ]
    }
  ],
  "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

projectId

string

required

A project 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 project's searches returned

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

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

fetch('https://api.revcenter.ai/v1/projects/{projectId}/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,
      "first_search_id": "0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61",
      "search_ids": [
        "0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61",
        "7d2e4f1a-0c3b-4a5d-9e8f-6b1c2d3e4f52"
      ]
    }
  ],
  "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 project's searches returned

Authorizations

Path Parameters

Query Parameters

Response