List contact custom field definitions

Returns the workspace custom field definitions available for contacts.

GET /contacts/custom-fields

List contact custom field definitions

cURL

curl --request GET \
  --url https://app.leonar.app/api/v1/contacts/custom-fields \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.leonar.app/api/v1/contacts/custom-fields"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.leonar.app/api/v1/contacts/custom-fields', 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.leonar.app/api/v1/contacts/custom-fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.leonar.app/api/v1/contacts/custom-fields"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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.leonar.app/api/v1/contacts/custom-fields")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.leonar.app/api/v1/contacts/custom-fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "cf2b8df3-1c85-4e5d-8f50-0c10b3994e90",
      "key": "crm_tier",
      "label": "CRM Tier",
      "type": "select",
      "options": [
        {
          "value": "enterprise",
          "label": "Enterprise"
        },
        {
          "value": "mid_market",
          "label": "Mid-market"
        }
      ],
      "is_required": false,
      "position": 0
    }
  ],
  "meta": {
    "total": 142,
    "limit": 50,
    "offset": 0,
    "has_more": true
  }
}

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Limit: 2000 requests per hour."
  }
}

Authorizations

Authorization · string · header · required

API key starting with leo_

Response

200

application/json

List of contact custom field definitions

data · object[]

Show child attributes

meta · object

Show child attributes

Example:

{
  "total": 142,
  "limit": 50,
  "offset": 0,
  "has_more": true
}