Retrieve all custom attribute definitions.
curl --request GET \
--url https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitionsimport requests
url = "https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"metadata": {
"limit": 0,
"offset": 0,
"total": 0
},
"items": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"ControlType": "string",
"ControlParams": "string",
"Label": "string",
"SystemName": "string",
"EntityType": 0,
"Position": 0,
"Hidden": false
}
]
}Attributes
Retrieve all custom attribute definitions.
entityType is the name of an EntityType enum value, for example: Account, Person, Deal. Definitions describe the labels, system names, and control types of the custom attributes that have been added to that entity.
GET
/
api
/
v1
/
attributes
/
{entityType}
/
definitions
Retrieve all custom attribute definitions.
curl --request GET \
--url https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitionsimport requests
url = "https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.outseta.com/api/v1/attributes/{entityType}/definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"metadata": {
"limit": 0,
"offset": 0,
"total": 0
},
"items": [
{
"Uid": "string",
"_objectType": "string",
"Created": "string",
"Updated": "string",
"ActivityEventData": {},
"ControlType": "string",
"ControlParams": "string",
"Label": "string",
"SystemName": "string",
"EntityType": 0,
"Position": 0,
"Hidden": false
}
]
}Path Parameters
The entity type whose attribute definitions to retrieve (e.g. Account, Person, Deal)
Query Parameters
Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.
Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).