Skip to main content
cURL
curl --request GET \
  --url https://api.sandbox.verisoul.ai/list/{list_name} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.sandbox.verisoul.ai/list/{list_name}"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.verisoul.ai/list/{list_name}', 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://api.sandbox.verisoul.ai/list/{list_name}",
  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://api.sandbox.verisoul.ai/list/{list_name}"

	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))

}
HttpResponse<String> response = Unirest.get("https://api.sandbox.verisoul.ai/list/{list_name}")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.verisoul.ai/list/{list_name}")

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
{
  "request_id": "bb152ba5-8311-4192-846f-1670a581becb",
  "description": "List of US based users",
  "accounts": [
    "john-doe",
    "john-doe-2",
    "amy-williams",
    "frank-smith",
    "mark-johnson"
  ]
}
{
  "message": "List not found",
  "statusCode": 400
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
list_name
string
required

Name of the list to retrieve accounts from

Response

List accounts response

​
request_id
string

The ID of the request

​
description
string

Description of the list's purpose

​
accounts
string[]

Array of account IDs in the list