Skip to main content

API access

Talentlens AI can be connected to your own systems, such as an HR tool or a job portal, so that CVs, job descriptions and match results move between them without manual work.

This page explains how to get access. The technical reference is not published here. It is available inside your workspace after you sign in.

Who can set this up​

API access is managed by an administrator account in your company. If you do not see a Developer & API group in your sidebar, ask your administrator.

Create credentials​

  1. Sign in and open API Keys.

  2. Select Generate API Credentials.

  3. Enter an Integration Client Name that says what the integration is, for example "Careers site sync". Letters, numbers, spaces, hyphens and underscores are allowed.

  4. Choose the Permissions the integration needs:

    PermissionAllows the integration to
    Read ResumesRead candidate profiles and CVs
    Write ResumesUpload CVs and update candidate profiles
    Read JobsRead job descriptions
    Write JobsCreate, edit and delete job descriptions
    Read MatchesRead match results
    Trigger MatchesStart a match run

  5. Generate the credentials.

Copy the secret straight away

The Client Secret is shown once. Copy it and store it somewhere safe before you close the window. It cannot be shown again. If you lose it, delete the client and create a new one.

Good practice​

  • Give each integration its own credentials, so you can switch one off without affecting the others.
  • Grant only the permissions the integration needs.
  • Never put the secret in a web page, a mobile app, an email or a chat message.
  • Switch a client off, or delete it, as soon as it is no longer used.

Manage existing clients​

On the API Keys screen you can see each client's permissions and when it was last used, switch a client on or off, and delete it. An integration belongs to one company and can only reach that company's data.

Track usage​

Open Usage & Quotas to see how much your company has used in a period: CVs processed, jobs parsed and matches run. Choose the period at the top of the screen.

The technical reference​

Open API Documentation in the Developer & API group of the sidebar. You need to be signed in.

Last updated on