curl --request GET \
--url https://production-api.joinrings.com/v1/lists/{list_uuid}/entities \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/lists/{list_uuid}/entities"
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://production-api.joinrings.com/v1/lists/{list_uuid}/entities', 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://production-api.joinrings.com/v1/lists/{list_uuid}/entities",
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://production-api.joinrings.com/v1/lists/{list_uuid}/entities"
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://production-api.joinrings.com/v1/lists/{list_uuid}/entities")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/lists/{list_uuid}/entities")
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{
"items": [
{
"entity_kind": "<string>",
"entity_uuid": "<string>"
}
],
"page": 123,
"per_page": 123,
"total": 123,
"has_more": true,
"next_cursor": "<string>"
}List entity list members
Use GET /v1/companies?uuids=... or GET /v1/persons?uuids=... to
hydrate the returned UUIDs into full records, depending on the list’s
kind (from GET /v1/lists).
city, state and country filter members by where they are based —
“who on this list is in LA” in one call, instead of paging every member
and hydrating each one to check. They AND together. Members with no
location on record are excluded when a location filter is set.
curl --request GET \
--url https://production-api.joinrings.com/v1/lists/{list_uuid}/entities \
--header 'x-api-key: <api-key>'import requests
url = "https://production-api.joinrings.com/v1/lists/{list_uuid}/entities"
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://production-api.joinrings.com/v1/lists/{list_uuid}/entities', 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://production-api.joinrings.com/v1/lists/{list_uuid}/entities",
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://production-api.joinrings.com/v1/lists/{list_uuid}/entities"
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://production-api.joinrings.com/v1/lists/{list_uuid}/entities")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/lists/{list_uuid}/entities")
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{
"items": [
{
"entity_kind": "<string>",
"entity_uuid": "<string>"
}
],
"page": 123,
"per_page": 123,
"total": 123,
"has_more": true,
"next_cursor": "<string>"
}Authorizations
Path Parameters
Query Parameters
Page number, 1-indexed. Clamped to >= 1.
Results per page (default 10). Clamped to the range 1-50 (values outside are silently capped, not rejected).
Opaque cursor from a previous response's next_cursor. When supplied, the page starts immediately after the last record of that response and page is ignored — unlike page, this cannot skip or repeat records when the data changes mid-scan. Filters and sort must stay identical for the whole scan; changing one is a 400. Not supported by every list endpoint — those that support it return next_cursor.
Case-insensitive substring on the member's city (e.g. 'Los Angeles'). Pass the full city name, not an abbreviation — 'LA' is matched as a substring and hits Dallas and Cleveland, not Los Angeles.
Member's state/region. A full name ('Florida') works on its own; a two-letter code ('FL', 'NY') is ISO 3166-2 and requires country, since unscoped 'CA' means Alberta. Returns 400 if it does not resolve.
Member's country, name or ISO code ('US', 'United States'). Required next to a two-letter state. Returns 400 if unrecognized.