Get credit balances

GET

credits

Get credit balances

curl --request GET \
  --url https://app.kalent.ai/api/v1/credits \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.kalent.ai/api/v1/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kalent.ai/api/v1/credits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kalent.ai/api/v1/credits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.kalent.ai/api/v1/credits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

First time? Set up Authentication

Learn how to authenticate your API requests with your API key.

Reads the two credit balances of the workspace that owns the API key. The call does not search and does not spend credits. It does not require an active subscription. The request still counts in the per-key rate-limit windows. Query parameters are ignored. The workspace always comes from the API key.

Response

When success is true, data contains:

api.remaining — API credits still available for talent search and qualified search. This is the sum of unexpired API credit grants, the same number as the X-Api-Credits-Remaining header on routes that send it. Credits held by a running qualified search are not included until they are returned. This is not creditsRemaining from a qualified-search result, which is the budget left on that call.
contact.remaining is the contact-credit balance shown in the Kalent app: the credits granted at the last plan reset, plus credits added since, minus credits spent since. Enrichments still in progress are not deducted yet. It can differ from the amount Kalent checks before starting an enrichment or sending an SMS. When they differ, the enrichment response (402 insufficient_credits) or the paused sequence is what applies. The value can be 0 before the first plan reset, and it is not floored at 0.

This route does not send X-Api-Credits-Used or X-Api-Credits-Remaining.

{
  "success": true,
  "data": {
    "api": { "remaining": 58 },
    "contact": { "remaining": 117 }
  }
}

Errors

Code	HTTP
`missing_api_key` / `invalid_api_key`	401
`rate_limit_exceeded`	429
`internal_error`	500

A workspace with no balance history returns 0 for both fields. The route does not respond with 402 or 404.

curl https://app.kalent.ai/api/v1/credits \
  -H "x-api-key: YOUR_API_KEY"

Get credit balances

curl --request GET \
  --url https://app.kalent.ai/api/v1/credits \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.kalent.ai/api/v1/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.kalent.ai/api/v1/credits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kalent.ai/api/v1/credits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.kalent.ai/api/v1/credits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

Getting Started

Search preparation

Talent search (L1)

Qualified search (L2)

LinkedIn contact enrichment

First time? Set up Authentication

Response

Errors

First time? Set up Authentication

​Response

​Errors

Response

Errors