Skip to main content
GET
/
management
/
contact-attribute-keys
Get contact attribute keys
curl --request GET \
  --url https://app.formbricks.com/api/v2/management/contact-attribute-keys \
  --header 'x-api-key: <api-key>'
import requests

url = "https://app.formbricks.com/api/v2/management/contact-attribute-keys"

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', 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",
  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"

	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")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.formbricks.com/api/v2/management/contact-attribute-keys")

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
{
  "data": [
    {
      "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>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Use your Formbricks x-api-key to authenticate.

Query Parameters

​
limit
number
default:50

Number of items to return

Required range: 1 <= x <= 250
​
skip
number
default:0

Number of items to skip

Required range: x >= 0
​
sortBy
enum<string>
default:createdAt

Sort by field

Available options:
createdAt,
updatedAt
​
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
​
startDate
string

Start date

​
endDate
string

End date

​
filterDateField
enum<string>

Date field to filter by

Available options:
createdAt,
updatedAt
​
workspaceId
string

The Workspace ID to filter by

​
environmentId
string

Deprecated alias for workspaceId

Response

200 - application/json

Contact attribute keys retrieved successfully.

​
data
object[]
​
meta
object