Contactos
Obtener esquema de contactos
Consulta los campos configurados para crear, actualizar y buscar contactos.
GET
/
tenants
/
{tenantId}
/
schemas
/
contact
Obtener esquema de contactos
curl --request GET \
--url https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact \
--header 'x-ib-api-key: <api-key>'import requests
url = "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact"
headers = {"x-ib-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};
fetch('https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};
fetch('https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact';
const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")
.header("x-ib-api-key", "<api-key>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-ib-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-ib-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact",
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-ib-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}val client = OkHttpClient()
val request = Request.Builder()
.url("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")
.get()
.addHeader("x-ib-api-key", "<api-key>")
.build()
val response = client.newCall(request).execute()falseimport Foundation
let url = URL(string: "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-ib-api-key": "<api-key>"]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))$headers=@{}
$headers.Add("x-ib-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact' -Method GET -Headers $headers{
"entityType": "contact",
"version": 3,
"fields": [
{
"id": "email",
"jsonSchema": {
"type": "string",
"format": "email",
"description": "Correo electrónico del contacto"
},
"ui": {
"label": "Correo electrónico",
"order": 4,
"visible": true
},
"readOnly": false
},
{
"id": "status",
"jsonSchema": {
"type": "string",
"enum": [
"Prospecto",
"Cliente"
]
},
"ui": {
"label": "Estatus",
"order": 5,
"visible": true
},
"readOnly": false
}
]
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Obtén la definición de los campos disponibles para los contactos de tu cuenta. Consulta este esquema antes de crear filtros para Buscar contactos.
Respuesta exitosa (
La respuesta puede incluir metadatos adicionales. Para integrar contactos utiliza:
Para ordenar, usa el
Endpoint
GET /tenants/{tenantId}/schemas/contact
Parámetros de ruta
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
tenantId | string | Sí | Identificador de tu cuenta. Solicítalo junto con tu API key si no lo tienes. |
Ejemplo de solicitud
curl "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact" \
-H "x-ib-api-key: TU_API_KEY"
Respuesta exitosa (200)
{
"entityType": "contact",
"version": 3,
"fields": [
{
"id": "email",
"jsonSchema": {
"type": "string",
"format": "email",
"description": "Correo electrónico del contacto"
},
"ui": {
"label": "Correo electrónico",
"order": 4,
"visible": true
},
"readOnly": false
},
{
"id": "status",
"jsonSchema": {
"type": "string",
"enum": ["Prospecto", "Cliente"]
},
"ui": {
"label": "Estatus",
"order": 5,
"visible": true
},
"readOnly": false
}
]
}
| Campo | Descripción |
|---|---|
version | Versión actual del esquema. Actualiza tu configuración cuando cambie. |
fields[].id | Identificador técnico que debes enviar como propiedad del contacto y usar en filtros u ordenamiento. |
fields[].jsonSchema | Tipo, formato, valores permitidos y demás reglas de validación. |
fields[].ui.label | Nombre visible del campo. No lo uses como identificador en solicitudes. |
fields[].readOnly | Indica si la API administra el valor. No envíes campos de solo lectura al crear o actualizar. |
Usar el esquema en una búsqueda
Para una coincidencia exacta sobre un campo de texto, toma suid y agrega .keyword:
{
"esQuery": {
"term": {
"email.keyword": "contacto@example.com"
}
}
}
id sin modificar:
{
"sort": [
{
"property": "email",
"direction": "ascending"
}
]
}
Usa siempre
fields[].id. Las etiquetas de ui.label pueden cambiar y no son propiedades válidas del contacto.Errores frecuentes
| HTTP | Qué significa | Qué hacer |
|---|---|---|
401 | API key inválida o faltante. | Verifica x-ib-api-key. |
403 | El tenantId no corresponde a la API key. | Confirma el identificador de tu cuenta. |
404 | No existe un esquema de contactos configurado. | Contacta a tu ejecutivo de cuenta. |
500 | No fue posible consultar el esquema. | Reintenta; si continúa, contacta soporte. |
Authorizations
Path Parameters
Identificador de la cuenta asociado a la API key.
Was this page helpful?
Obtener esquema de contactos
curl --request GET \
--url https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact \
--header 'x-ib-api-key: <api-key>'import requests
url = "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact"
headers = {"x-ib-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};
fetch('https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};
fetch('https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact';
const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")
.header("x-ib-api-key", "<api-key>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-ib-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-ib-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact",
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-ib-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}val client = OkHttpClient()
val request = Request.Builder()
.url("https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")
.get()
.addHeader("x-ib-api-key", "<api-key>")
.build()
val response = client.newCall(request).execute()falseimport Foundation
let url = URL(string: "https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-ib-api-key": "<api-key>"]
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))$headers=@{}
$headers.Add("x-ib-api-key", "<api-key>")
$response = Invoke-WebRequest -Uri 'https://api.insuranceboosters.com/api/v1/tenants/{tenantId}/schemas/contact' -Method GET -Headers $headers{
"entityType": "contact",
"version": 3,
"fields": [
{
"id": "email",
"jsonSchema": {
"type": "string",
"format": "email",
"description": "Correo electrónico del contacto"
},
"ui": {
"label": "Correo electrónico",
"order": 4,
"visible": true
},
"readOnly": false
},
{
"id": "status",
"jsonSchema": {
"type": "string",
"enum": [
"Prospecto",
"Cliente"
]
},
"ui": {
"label": "Estatus",
"order": 5,
"visible": true
},
"readOnly": false
}
]
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}
