Skip to main content
GET
/
v1
/
contacts
/
fields
Get contact field metadata
curl --request GET \
  --url https://openapi.enginy.ai/v1/contacts/fields \
  --header 'x-api-key: <api-key>'
{
  "message": "<string>",
  "data": {
    "fields": [
      {
        "id": "<string>",
        "label": "<string>",
        "dataType": "<string>",
        "editable": true,
        "searchable": true,
        "sortable": true,
        "importable": true,
        "exportable": true,
        "promptReference": "<string>"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Query Parameters

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

Contact field metadata retrieved successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object
required