Fields

Listar campos disponíveis

Retorna todos os campos disponíveis para as entidades properties e leads. Use este endpoint para descobrir quais campos podem ser solicitados no parâmetro fields dos endpoints de listagem.

Campos podem ser simples (retornam valor direto) ou agrupados (retornam objeto com sub-campos).

curl -X GET "https://sandbox-partner-api.keyspot.com.br/v1/fields" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)"

import requests
import json

url = "https://sandbox-partner-api.keyspot.com.br/v1/fields"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}

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

const response = await fetch("https://sandbox-partner-api.keyspot.com.br/v1/fields", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://sandbox-partner-api.keyspot.com.br/v1/fields", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://sandbox-partner-api.keyspot.com.br/v1/fields')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'

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

{
  "data": {
    "properties": {
      "id": {
        "description": "Unique identifier"
      },
      "code": {
        "description": "Property code"
      },
      "title": {
        "description": "Property title"
      },
      "address": {
        "description": "Address information",
        "fields": {
          "street": {
            "description": "Street name"
          },
          "number": {
            "description": "Street number"
          },
          "neighborhood": {
            "description": "Neighborhood name"
          },
          "city": {
            "description": "City name"
          },
          "state": {
            "description": "State name"
          },
          "uf": {
            "description": "State abbreviation"
          },
          "cep": {
            "description": "Postal code"
          }
        }
      }
    },
    "leads": {
      "id": {
        "description": "Unique identifier"
      },
      "name": {
        "description": "Lead name"
      },
      "email": {
        "description": "Lead email"
      }
    }
  }
}