API reference

Get the share link

The project’s one public shortlist link, to paste into an email to the client; it always shows the live shortlist. Every project has exactly one link, made with the project, so this returns the same URL every time and never mints a second one. Anyone with the link can open the list, and it shows the shortlist as it stands: remove anyone who shouldn’t be seen before sending it, and after a change send the same link again. shortlisted is how many people it shows now; don’t send a link with 0. Does not use credits.

Needs scope shortlists:read.

GET

projects

{projectId}

share-link

Get the share link

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

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

fetch('https://api.revcenter.ai/v1/projects/{projectId}/share-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revcenter.ai/v1/projects/{projectId}/share-link"

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

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

print(response.text)

{
  "data": {
    "project_id": "6f1c2a0e-3b7d-4c1e-9a52-0d4e8b7c1a11",
    "url": "https://app.revcenter.ai/share/rvs_3f9a1c7e2b",
    "shortlisted": 14
  },
  "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

Response

data

object

Show child attributes

meta

object

Show child attributes

Get the share link

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

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

fetch('https://api.revcenter.ai/v1/projects/{projectId}/share-link', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revcenter.ai/v1/projects/{projectId}/share-link"

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

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

print(response.text)

{
  "data": {
    "project_id": "6f1c2a0e-3b7d-4c1e-9a52-0d4e8b7c1a11",
    "url": "https://app.revcenter.ai/share/rvs_3f9a1c7e2b",
    "shortlisted": 14
  },
  "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 the share link

Authorizations

Path Parameters

Response