List members

List members

curl --request GET \
  --url https://api.tented.ai/v1/contact-lists/{listId}/contacts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tented.ai/v1/contact-lists/{listId}/contacts', 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.tented.ai/v1/contact-lists/{listId}/contacts",
  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: Bearer <token>"
  ],
]);

$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.tented.ai/v1/contact-lists/{listId}/contacts"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.tented.ai/v1/contact-lists/{listId}/contacts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "contacts": [
    {
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "original_source": "<string>",
      "original_source_detail": "<string>",
      "company": "<string>",
      "job_title": "<string>",
      "lead_status": "<string>",
      "lifecycle_stage": "<string>",
      "tented_score": 123,
      "last_activity_at": "2023-11-07T05:31:56Z",
      "member_added_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

{
  "error": "<string>",
  "error_code": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "limit": 123,
  "current": 123
}

{
  "error": "<string>",
  "error_code": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "limit": 123,
  "current": 123
}

{
  "error": "<string>",
  "error_code": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "limit": 123,
  "current": 123
}

GET

contact-lists

{listId}

contacts

List members

curl --request GET \
  --url https://api.tented.ai/v1/contact-lists/{listId}/contacts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tented.ai/v1/contact-lists/{listId}/contacts', 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.tented.ai/v1/contact-lists/{listId}/contacts",
  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: Bearer <token>"
  ],
]);

$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.tented.ai/v1/contact-lists/{listId}/contacts"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.tented.ai/v1/contact-lists/{listId}/contacts")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "contacts": [
    {
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "original_source": "<string>",
      "original_source_detail": "<string>",
      "company": "<string>",
      "job_title": "<string>",
      "lead_status": "<string>",
      "lifecycle_stage": "<string>",
      "tented_score": 123,
      "last_activity_at": "2023-11-07T05:31:56Z",
      "member_added_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}

{
  "error": "<string>",
  "error_code": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "limit": 123,
  "current": 123
}

{
  "error": "<string>",
  "error_code": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "limit": 123,
  "current": 123
}

{
  "error": "<string>",
  "error_code": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "limit": 123,
  "current": 123
}

Authorizations

Authorization

string

header

required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

listId

string<uuid>

required

Contact list ID.

Query Parameters

page

integer

default:1

1-based page number.

Required range: x >= 1

limit

integer

default:25

Page size (1-100).

Required range: 1 <= x <= 100

string

Case-insensitive name/email search.

sort

enum<string>

default:updated_at

Sort key. member_added_at sorts by when the contact joined this list.

Available options:

member_added_at,

created_at,

updated_at,

last_activity_at,

display_name,

first_name,

last_name,

normalized_email,

original_source

order

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

exclude_unsubscribed

enum<string>

When set, omit contacts unsubscribed from marketing email.

Available options:

1,

true

only_unsubscribed

enum<string>

When set, return only contacts unsubscribed from marketing email. exclude_unsubscribed wins if both are set.

Available options:

1,

true

Response

One page of list members.

contacts

object[]

required

Show child attributes

pagination

object

required

Offset pagination metadata.

Show child attributes

Tents

Analytics

Contacts

Emails

Email Blasts

Triggered Flows

Contact Imports

Contact Fields

Contact Lists

Email Templates

Tent Templates

Authorizations

Path Parameters

Query Parameters

Response