Contacts Matching
curl --request POST \
--url https://api.member.dev/api/v1/teams/{team_id}/segments/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"attributes": {
"conditions": {
"groups": [
{
"conditions": [
{
"operator": "<string>",
"type": "email",
"value": {
"text": "<string>"
}
}
],
"logic": "AND"
}
],
"version": 1
},
"page": {
"after": "<string>",
"size": 25
}
},
"type": "segment_search"
}
}
'import requests
url = "https://api.member.dev/api/v1/teams/{team_id}/segments/search"
payload = { "data": {
"attributes": {
"conditions": {
"groups": [
{
"conditions": [
{
"operator": "<string>",
"type": "email",
"value": { "text": "<string>" }
}
],
"logic": "AND"
}
],
"version": 1
},
"page": {
"after": "<string>",
"size": 25
}
},
"type": "segment_search"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
attributes: {
conditions: {
groups: [
{
conditions: [{operator: '<string>', type: 'email', value: {text: '<string>'}}],
logic: 'AND'
}
],
version: 1
},
page: {after: '<string>', size: 25}
},
type: 'segment_search'
}
})
};
fetch('https://api.member.dev/api/v1/teams/{team_id}/segments/search', 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.member.dev/api/v1/teams/{team_id}/segments/search",
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([
'data' => [
'attributes' => [
'conditions' => [
'groups' => [
[
'conditions' => [
[
'operator' => '<string>',
'type' => 'email',
'value' => [
'text' => '<string>'
]
]
],
'logic' => 'AND'
]
],
'version' => 1
],
'page' => [
'after' => '<string>',
'size' => 25
]
],
'type' => 'segment_search'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+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.member.dev/api/v1/teams/{team_id}/segments/search"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"conditions\": {\n \"groups\": [\n {\n \"conditions\": [\n {\n \"operator\": \"<string>\",\n \"type\": \"email\",\n \"value\": {\n \"text\": \"<string>\"\n }\n }\n ],\n \"logic\": \"AND\"\n }\n ],\n \"version\": 1\n },\n \"page\": {\n \"after\": \"<string>\",\n \"size\": 25\n }\n },\n \"type\": \"segment_search\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+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.member.dev/api/v1/teams/{team_id}/segments/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"attributes\": {\n \"conditions\": {\n \"groups\": [\n {\n \"conditions\": [\n {\n \"operator\": \"<string>\",\n \"type\": \"email\",\n \"value\": {\n \"text\": \"<string>\"\n }\n }\n ],\n \"logic\": \"AND\"\n }\n ],\n \"version\": 1\n },\n \"page\": {\n \"after\": \"<string>\",\n \"size\": 25\n }\n },\n \"type\": \"segment_search\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.member.dev/api/v1/teams/{team_id}/segments/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"attributes\": {\n \"conditions\": {\n \"groups\": [\n {\n \"conditions\": [\n {\n \"operator\": \"<string>\",\n \"type\": \"email\",\n \"value\": {\n \"text\": \"<string>\"\n }\n }\n ],\n \"logic\": \"AND\"\n }\n ],\n \"version\": 1\n },\n \"page\": {\n \"after\": \"<string>\",\n \"size\": 25\n }\n },\n \"type\": \"segment_search\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"attributes": {
"contact_id": "<string>",
"team_id": "<string>"
},
"id": "<string>",
"type": "team_contact_ref"
}
],
"links": {},
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}segments-admin
Contacts Matching
Preview the members of an un-persisted condition tree.
Compiles the tree through the same pipeline used on save (slug →
FK ID, display decoration, cross-team validation) but never writes
a segments row. 422 on compile failure; otherwise returns a
page of team_contact references.
POST
/
api
/
v1
/
teams
/
{team_id}
/
segments
/
search
Contacts Matching
curl --request POST \
--url https://api.member.dev/api/v1/teams/{team_id}/segments/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"attributes": {
"conditions": {
"groups": [
{
"conditions": [
{
"operator": "<string>",
"type": "email",
"value": {
"text": "<string>"
}
}
],
"logic": "AND"
}
],
"version": 1
},
"page": {
"after": "<string>",
"size": 25
}
},
"type": "segment_search"
}
}
'import requests
url = "https://api.member.dev/api/v1/teams/{team_id}/segments/search"
payload = { "data": {
"attributes": {
"conditions": {
"groups": [
{
"conditions": [
{
"operator": "<string>",
"type": "email",
"value": { "text": "<string>" }
}
],
"logic": "AND"
}
],
"version": 1
},
"page": {
"after": "<string>",
"size": 25
}
},
"type": "segment_search"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
attributes: {
conditions: {
groups: [
{
conditions: [{operator: '<string>', type: 'email', value: {text: '<string>'}}],
logic: 'AND'
}
],
version: 1
},
page: {after: '<string>', size: 25}
},
type: 'segment_search'
}
})
};
fetch('https://api.member.dev/api/v1/teams/{team_id}/segments/search', 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.member.dev/api/v1/teams/{team_id}/segments/search",
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([
'data' => [
'attributes' => [
'conditions' => [
'groups' => [
[
'conditions' => [
[
'operator' => '<string>',
'type' => 'email',
'value' => [
'text' => '<string>'
]
]
],
'logic' => 'AND'
]
],
'version' => 1
],
'page' => [
'after' => '<string>',
'size' => 25
]
],
'type' => 'segment_search'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+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.member.dev/api/v1/teams/{team_id}/segments/search"
payload := strings.NewReader("{\n \"data\": {\n \"attributes\": {\n \"conditions\": {\n \"groups\": [\n {\n \"conditions\": [\n {\n \"operator\": \"<string>\",\n \"type\": \"email\",\n \"value\": {\n \"text\": \"<string>\"\n }\n }\n ],\n \"logic\": \"AND\"\n }\n ],\n \"version\": 1\n },\n \"page\": {\n \"after\": \"<string>\",\n \"size\": 25\n }\n },\n \"type\": \"segment_search\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/vnd.api+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.member.dev/api/v1/teams/{team_id}/segments/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"attributes\": {\n \"conditions\": {\n \"groups\": [\n {\n \"conditions\": [\n {\n \"operator\": \"<string>\",\n \"type\": \"email\",\n \"value\": {\n \"text\": \"<string>\"\n }\n }\n ],\n \"logic\": \"AND\"\n }\n ],\n \"version\": 1\n },\n \"page\": {\n \"after\": \"<string>\",\n \"size\": 25\n }\n },\n \"type\": \"segment_search\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.member.dev/api/v1/teams/{team_id}/segments/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"attributes\": {\n \"conditions\": {\n \"groups\": [\n {\n \"conditions\": [\n {\n \"operator\": \"<string>\",\n \"type\": \"email\",\n \"value\": {\n \"text\": \"<string>\"\n }\n }\n ],\n \"logic\": \"AND\"\n }\n ],\n \"version\": 1\n },\n \"page\": {\n \"after\": \"<string>\",\n \"size\": 25\n }\n },\n \"type\": \"segment_search\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"attributes": {
"contact_id": "<string>",
"team_id": "<string>"
},
"id": "<string>",
"type": "team_contact_ref"
}
],
"links": {},
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}{
"errors": [
{
"status": "<string>",
"title": "<string>",
"code": "<string>",
"detail": "<string>",
"id": "<string>",
"meta": {},
"source": {}
}
],
"meta": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/vnd.api+json
Show child attributes
Show child attributes
Response
Successful Response
JSON:API list response for team-contact-ref resources.
Returned by GET /{segment_id}/members. The meta and links
shapes mirror the pattern used by other paginated list endpoints in this
module.
⌘I