Get Contact Attribute Key by ID
curl --request GET \
--url https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}', 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://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}",
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: <x-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://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-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://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"createdAt": "2024-11-07T12:25:48.589Z",
"description": "The email of the person",
"id": "cm37a748d000ahbwhd5bbwc09",
"isUnique": true,
"key": "email",
"name": "email",
"type": "default",
"updatedAt": "2024-12-03T13:30:28.620Z",
"workspaceId": "cm37a748d0008hbwhqvvuba23"
}
}{
"code": "not_found",
"details": {
"resource_id": "cm37a748d000ahbwhd5bbwc09",
"resource_type": "ContactAttributeKey"
},
"message": "Contact attribute key not found"
}Management API - Contact Attribute Keys
Get Contact Attribute Key by ID
Retrieve a specific contact attribute key by its ID. This returns detailed information about how a particular attribute is defined in your workspace.
GET
/
api
/
v1
/
management
/
contact-attribute-keys
/
{contactAttributeKeyId}
Get Contact Attribute Key by ID
curl --request GET \
--url https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId} \
--header 'x-api-key: <x-api-key>'import requests
url = "https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}', 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://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}",
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: <x-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://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-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://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseurl}/api/v1/management/contact-attribute-keys/{contactAttributeKeyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"createdAt": "2024-11-07T12:25:48.589Z",
"description": "The email of the person",
"id": "cm37a748d000ahbwhd5bbwc09",
"isUnique": true,
"key": "email",
"name": "email",
"type": "default",
"updatedAt": "2024-12-03T13:30:28.620Z",
"workspaceId": "cm37a748d0008hbwhqvvuba23"
}
}{
"code": "not_found",
"details": {
"resource_id": "cm37a748d000ahbwhd5bbwc09",
"resource_type": "ContactAttributeKey"
},
"message": "Contact attribute key not found"
}Was this page helpful?
⌘I