Campos

Listar

get
Autorizações
Parâmetros de consulta
EntityTypestring · enumOpcional

Tipo de entidade do campo personalizado.

Default: CONTACTValores possíveis:
NestedListbooleanOpcional

Determina a estrutura da lista retornada. Se verdadeiro, os campos serão retornados de forma aninhada, isto é, estruturado em grupos.

Default: false
Respostas
200

Success

application/json
get
/v1/custom-field
GET /core/v1/custom-field HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-11-06T22:29:59.736Z",
    "updatedAt": "2025-11-06T22:29:59.736Z",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "GROUP",
    "entityType": "CONTACT",
    "scopeId": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "key": "text",
    "position": 1,
    "required": true,
    "visible": true,
    "isValueRange": true,
    "options": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    ],
    "children": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-11-06T22:29:59.736Z",
        "updatedAt": "2025-11-06T22:29:59.736Z",
        "parentId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "GROUP",
        "entityType": "CONTACT",
        "scopeId": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "key": "text",
        "position": 1,
        "required": true,
        "visible": true,
        "isValueRange": true,
        "options": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          }
        ],
        "children": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdAt": "2025-11-06T22:29:59.736Z",
            "updatedAt": "2025-11-06T22:29:59.736Z",
            "parentId": "123e4567-e89b-12d3-a456-426614174000",
            "type": "GROUP",
            "entityType": "CONTACT",
            "scopeId": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "key": "text",
            "position": 1,
            "required": true,
            "visible": true,
            "isValueRange": true,
            "options": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text"
              }
            ],
            "children": "[Circular Reference]"
          }
        ]
      }
    ]
  }
]

Atualizado