Get Team Credits

Retrieves the remaining credits balance for your team’s account.

GET /team/credits

Get Team Credits

cURL

curl --request GET \
  --url https://api.lemlist.com/api/team/credits \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.lemlist.com/api/team/credits"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.lemlist.com/api/team/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.lemlist.com/api/team/credits")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lemlist.com/api/team/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 => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

200

{
  "credits": 100,
  "details": {
    "remaining": {
      "total": 100,
      "freemium": 0,
      "subscription": 80,
      "gifted": 10,
      "paid": 10
    }
  }
}

"No API key provided"

"The authentication you supplied is incorrect"

"User linked to this API key is blocked"

"No user found for this API key"

This endpoint uses the Credits object.

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200

application/json

Success

Credits are the coins a team uses to enrich emails, LinkedIn URLs, etc. Each enrichment feature needs a certain amount of credits to run.

credits · integer

Total credits remaining

details · object

Show child attributes