curl --request POST \
--url https://api.statisfy.com/v1/objects/user/records/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cursor": "<string>",
"fields": [
"<string>"
],
"filter": {
"field": "<string>",
"value": "<unknown>"
},
"limit": 25
}
'import requests
url = "https://api.statisfy.com/v1/objects/user/records/search"
payload = {
"cursor": "<string>",
"fields": ["<string>"],
"filter": {
"field": "<string>",
"value": "<unknown>"
},
"limit": 25
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cursor: '<string>',
fields: ['<string>'],
filter: {field: '<string>', value: '<unknown>'},
limit: 25
})
};
fetch('https://api.statisfy.com/v1/objects/user/records/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.statisfy.com/v1/objects/user/records/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([
'cursor' => '<string>',
'fields' => [
'<string>'
],
'filter' => [
'field' => '<string>',
'value' => '<unknown>'
],
'limit' => 25
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.statisfy.com/v1/objects/user/records/search"
payload := strings.NewReader("{\n \"cursor\": \"<string>\",\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.statisfy.com/v1/objects/user/records/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": \"<string>\",\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/objects/user/records/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/json'
request.body = "{\n \"cursor\": \"<string>\",\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"calendar_link": "<string>",
"department": "<string>",
"email": "<string>",
"fields": {},
"first_name": "<string>",
"last_name": "<string>",
"manager": "<string>",
"name": "<string>",
"role": "<string>",
"title": "<string>",
"user_id": "<string>"
}
],
"has_more": false,
"next_cursor": "<string>"
}Search users with AND/OR filters
Like listing, with the filter as a JSON tree: a condition {"field", "op", "value"} or a group {"and": [...]} / {"or": [...]}. Filter on department, email, id, manager, name, role, title, user_id: custom user fields cannot be filtered on. Text eq, contains and starts_with ignore case; id, user_id and manager match exactly. user_id exists lists the users with a login. A user is a teammate: someone with a Statisfy login, or a CRM user your CRM sync brought in. Contacts, vendors and digital workers are never users. id is what owner fields and a task’s creator hold. Custom fields under fields are the user fields, keyed as GET /v1/fields?object=user lists them. Their access role, membership and product licenses are not part of the record.
curl --request POST \
--url https://api.statisfy.com/v1/objects/user/records/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cursor": "<string>",
"fields": [
"<string>"
],
"filter": {
"field": "<string>",
"value": "<unknown>"
},
"limit": 25
}
'import requests
url = "https://api.statisfy.com/v1/objects/user/records/search"
payload = {
"cursor": "<string>",
"fields": ["<string>"],
"filter": {
"field": "<string>",
"value": "<unknown>"
},
"limit": 25
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cursor: '<string>',
fields: ['<string>'],
filter: {field: '<string>', value: '<unknown>'},
limit: 25
})
};
fetch('https://api.statisfy.com/v1/objects/user/records/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.statisfy.com/v1/objects/user/records/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([
'cursor' => '<string>',
'fields' => [
'<string>'
],
'filter' => [
'field' => '<string>',
'value' => '<unknown>'
],
'limit' => 25
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.statisfy.com/v1/objects/user/records/search"
payload := strings.NewReader("{\n \"cursor\": \"<string>\",\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.statisfy.com/v1/objects/user/records/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": \"<string>\",\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.statisfy.com/v1/objects/user/records/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/json'
request.body = "{\n \"cursor\": \"<string>\",\n \"fields\": [\n \"<string>\"\n ],\n \"filter\": {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"calendar_link": "<string>",
"department": "<string>",
"email": "<string>",
"fields": {},
"first_name": "<string>",
"last_name": "<string>",
"manager": "<string>",
"name": "<string>",
"role": "<string>",
"title": "<string>",
"user_id": "<string>"
}
],
"has_more": false,
"next_cursor": "<string>"
}Authorizations
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Body
Was this page helpful?