Get company field metadata

curl --request GET \
  --url https://openapi.enginy.ai/v1/companies/fields \
  --header 'x-api-key: <api-key>'

import requests

url = "https://openapi.enginy.ai/v1/companies/fields"

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://openapi.enginy.ai/v1/companies/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://openapi.enginy.ai/v1/companies/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 => [
    "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://openapi.enginy.ai/v1/companies/fields"

	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://openapi.enginy.ai/v1/companies/fields")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.enginy.ai/v1/companies/fields")

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

{
  "status": "success",
  "message": "<string>",
  "data": {
    "fields": [
      {
        "id": "<string>",
        "label": "<string>",
        "dataType": "<string>",
        "editable": true,
        "searchable": true,
        "sortable": true,
        "importable": true,
        "exportable": true,
        "promptReference": "<string>"
      }
    ]
  }
}

Companies

Get company field metadata

Retrieve the source-of-truth subset of company fields that can be referenced in AI-variable prompts and requested through the companies endpoints. This is not the full company field catalog; it only includes AI-variable-compatible fields for this workspace. Without query parameters this returns the full AI-variable-compatible company prompt-field catalog. For targeted lookups, pass search plus optional filters such as fieldType, matchMode, and limit to narrow the response and avoid oversized payloads; the older query parameter remains supported as an alias. Use this before manual or public AI-variable create/update calls instead of guessing placeholders; unsupported generic placeholders such as previousMessage are not valid here. This is narrower than the full editable/filterable company field catalog: search_companies_with_advanced_filters (include/exclude) and update_company_fields also accept relationship-style filters such as companyGroup and campaigns that never appear here because they cannot be used inside an AI-variable prompt.

Required scope: COMPANIES_READ

Rate limit: 100 requests per minute

GET

companies

fields

Get company field metadata

curl --request GET \
  --url https://openapi.enginy.ai/v1/companies/fields \
  --header 'x-api-key: <api-key>'

import requests

url = "https://openapi.enginy.ai/v1/companies/fields"

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://openapi.enginy.ai/v1/companies/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://openapi.enginy.ai/v1/companies/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 => [
    "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://openapi.enginy.ai/v1/companies/fields"

	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://openapi.enginy.ai/v1/companies/fields")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.enginy.ai/v1/companies/fields")

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

{
  "status": "success",
  "message": "<string>",
  "data": {
    "fields": [
      {
        "id": "<string>",
        "label": "<string>",
        "dataType": "<string>",
        "editable": true,
        "searchable": true,
        "sortable": true,
        "importable": true,
        "exportable": true,
        "promptReference": "<string>"
      }
    ]
  }
}

Authorizations

x-api-key

string

header

required

Query Parameters

string

Preferred case-insensitive search term for AI-variable-compatible field IDs, labels, and prompt placeholders. Use this for targeted MCP/tool lookups to keep payloads small.

query

string

Backward-compatible alias for search. Performs the same case-insensitive search over AI-variable-compatible field IDs, labels, and prompt placeholders.

fieldType

enum<string>

Optional filter by field type such as STANDARD or AI_VARIABLE.

Available options:

STANDARD,

AI_VARIABLE,

CRM_FIELD,

FORMULA_FIELD,

EMPTY_FIELD

matchMode

enum<string>

Optional search strictness. contains is the default broad match, prefix narrows to prefix matches, and exact only returns exact field ID, label, or placeholder matches.

Available options:

contains,

prefix,

exact

limit

string

Optional maximum number of matching fields to return. Minimum 1, maximum 100.

Response

200 - application/json

Company field metadata retrieved successfully

status

enum<string>

required

Available options:

success

message

string

required

data

object

required

Show child attributes

Bulk create contacts Create a new company

API documentation

Endpoints

Get company field metadata

Authorizations

Query Parameters

Response