cURL
curl --request GET \
--url https://app.revyops.com/api/public/custom-fields/schema \
--header 'X-API-KEY: <api-key>'import requests
url = "https://app.revyops.com/api/public/custom-fields/schema"
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://app.revyops.com/api/public/custom-fields/schema', 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://app.revyops.com/api/public/custom-fields/schema",
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://app.revyops.com/api/public/custom-fields/schema"
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://app.revyops.com/api/public/custom-fields/schema")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.revyops.com/api/public/custom-fields/schema")
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[
{
"object": "contact",
"field_name": "<string>",
"type": "text",
"available_options": [
"<string>"
],
"source": "agency",
"created_by": "<string>",
"filter_key": "<string>"
}
]Custom Fields
List Custom Field Schema
Lists every custom field this client can read or write, with its type (text, number, date, dropdown_singleselect, dropdown_multiselect), dropdown options and whether the agency master schema or the client defines it.
GET
/
public
/
custom-fields
/
schema
cURL
curl --request GET \
--url https://app.revyops.com/api/public/custom-fields/schema \
--header 'X-API-KEY: <api-key>'import requests
url = "https://app.revyops.com/api/public/custom-fields/schema"
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://app.revyops.com/api/public/custom-fields/schema', 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://app.revyops.com/api/public/custom-fields/schema",
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://app.revyops.com/api/public/custom-fields/schema"
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://app.revyops.com/api/public/custom-fields/schema")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.revyops.com/api/public/custom-fields/schema")
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[
{
"object": "contact",
"field_name": "<string>",
"type": "text",
"available_options": [
"<string>"
],
"source": "agency",
"created_by": "<string>",
"filter_key": "<string>"
}
]Authorizations
Query Parameters
contact or company
Response
200 - application/json
contact- contactcompany- company
Available options:
contact, company text- textnumber- numberdate- datedropdown_singleselect- dropdown_singleselectdropdown_multiselect- dropdown_multiselect
Available options:
text, number, date, dropdown_singleselect, dropdown_multiselect agency: defined in the agency master schema, its type is managed there; client: defined for this workspace only.
agency- agencyclient- client
Available options:
agency, client Firebase uid of the user who added it in the UI; null for fields created by the API, MCP or an import.
The field id to use in filter conditions, e.g. custom.fit_score.
Was this page helpful?

