Get a contact attribute key
curl --request GET \
--url https://app.formbricks.com/api/v2/management/contact-attribute-keys/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://app.formbricks.com/api/v2/management/contact-attribute-keys/{id}"
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.formbricks.com/api/v2/management/contact-attribute-keys/{id}', 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.formbricks.com/api/v2/management/contact-attribute-keys/{id}",
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.formbricks.com/api/v2/management/contact-attribute-keys/{id}"
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.formbricks.com/api/v2/management/contact-attribute-keys/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/contact-attribute-keys/{id}")
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{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"isUnique": false,
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"type": "custom",
"workspaceId": "<string>",
"environmentId": "<string>"
}Management API - Contact Attribute Keys
Get a contact attribute key
Gets a contact attribute key from the database.
GET
/
management
/
contact-attribute-keys
/
{id}
Get a contact attribute key
curl --request GET \
--url https://app.formbricks.com/api/v2/management/contact-attribute-keys/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://app.formbricks.com/api/v2/management/contact-attribute-keys/{id}"
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.formbricks.com/api/v2/management/contact-attribute-keys/{id}', 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.formbricks.com/api/v2/management/contact-attribute-keys/{id}",
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.formbricks.com/api/v2/management/contact-attribute-keys/{id}"
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.formbricks.com/api/v2/management/contact-attribute-keys/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/contact-attribute-keys/{id}")
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{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"isUnique": false,
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"type": "custom",
"workspaceId": "<string>",
"environmentId": "<string>"
}Authorizations
Use your Formbricks x-api-key to authenticate.
Path Parameters
The ID of the contact attribute key
Response
200 - application/json
Contact attribute key retrieved successfully.
The ID of the contact attribute key
The date and time the contact attribute key was created
Example:
"2021-01-01T00:00:00.000Z"
The date and time the contact attribute key was last updated
Example:
"2021-01-01T00:00:00.000Z"
Whether the attribute must have unique values across contacts
Example:
false
The attribute identifier used in the system
Example:
"email"
Display name for the attribute
Example:
"Email Address"
Description of the attribute
Example:
"The user's email address"
Whether this is a default or custom attribute
Available options:
default, custom Example:
"custom"
The ID of the Workspace this attribute belongs to
Deprecated alias for workspaceId.
Was this page helpful?