curl --request POST \
--url https://api.text.com/cdp/v1/get_segment_definitions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.text.com/cdp/v1/get_segment_definitions"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.text.com/cdp/v1/get_segment_definitions', 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.text.com/cdp/v1/get_segment_definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.text.com/cdp/v1/get_segment_definitions"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.text.com/cdp/v1/get_segment_definitions")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.text.com/cdp/v1/get_segment_definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"segment_definitions": [
{
"segment_id": 0,
"segment_type": "lead",
"definition": {
"type": "or",
"nodes": [
{
"type": "email_set"
},
{
"type": "phone_number_set"
}
]
},
"last_updated_at": null,
"agent_account_id": null,
"agent_client_id": null
},
{
"segment_id": 1,
"segment_type": "qualified_lead",
"definition": {
"type": "and",
"nodes": [
{
"type": "or",
"nodes": [
{
"type": "email_set"
},
{
"type": "phone_number_set"
}
]
},
{
"type": "name_set"
}
]
},
"last_updated_at": "2026-08-08T10:14:00Z",
"agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
"agent_client_id": "71d32c598862b01b9e2298281339dbc2"
},
{
"segment_id": 2,
"segment_type": "custom",
"definition": {
"type": "and",
"nodes": [
{
"type": "name_set"
},
{
"type": "customer_property_set",
"customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
}
]
},
"referenced_customer_properties_definitions_ids": [
"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
],
"last_updated_at": "2026-08-08T10:15:00Z",
"agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
"agent_client_id": "71d32c598862b01b9e2298281339dbc2"
}
]
}Get segment definitions
Returns every active segment definition for the organization.
curl --request POST \
--url https://api.text.com/cdp/v1/get_segment_definitions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.text.com/cdp/v1/get_segment_definitions"
payload = {}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.text.com/cdp/v1/get_segment_definitions', 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.text.com/cdp/v1/get_segment_definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.text.com/cdp/v1/get_segment_definitions"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.text.com/cdp/v1/get_segment_definitions")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.text.com/cdp/v1/get_segment_definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"segment_definitions": [
{
"segment_id": 0,
"segment_type": "lead",
"definition": {
"type": "or",
"nodes": [
{
"type": "email_set"
},
{
"type": "phone_number_set"
}
]
},
"last_updated_at": null,
"agent_account_id": null,
"agent_client_id": null
},
{
"segment_id": 1,
"segment_type": "qualified_lead",
"definition": {
"type": "and",
"nodes": [
{
"type": "or",
"nodes": [
{
"type": "email_set"
},
{
"type": "phone_number_set"
}
]
},
{
"type": "name_set"
}
]
},
"last_updated_at": "2026-08-08T10:14:00Z",
"agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
"agent_client_id": "71d32c598862b01b9e2298281339dbc2"
},
{
"segment_id": 2,
"segment_type": "custom",
"definition": {
"type": "and",
"nodes": [
{
"type": "name_set"
},
{
"type": "customer_property_set",
"customer_property_id": "9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
}
]
},
"referenced_customer_properties_definitions_ids": [
"9b1c9e0a-3a4b-4f0e-9b6f-1f6c8a2b0d11"
],
"last_updated_at": "2026-08-08T10:15:00Z",
"agent_account_id": "bc35115a-6f12-40b4-bbb0-8187b0f68c8e",
"agent_client_id": "71d32c598862b01b9e2298281339dbc2"
}
]
}customers:roAuthorizations
Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.
Body
The body is of type object.
Response
List of segment definitions in the organization.
The active definitions for the organization, ordered by segment_id. Every organization starts with the lead definition at ID 0. The qualified lead definition at ID 1 appears only after the organization creates it. Deleted definitions are absent, so the array can be empty. Restoring a deleted lead or qualified lead definition reuses its fixed ID but may apply different conditions.
Show child attributes
Show child attributes
Was this page helpful?