> ## Documentation Index
> Fetch the complete documentation index at: https://developers.insuranceboosters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Contactos

> Consulta el esquema y crea, busca, actualiza o elimina contactos mediante la API.

La API de **Contactos** te permite administrar los contactos de tu cuenta y usar sus IDs en campos de tipo `contact_single` o `contact_multi` de [Tableros](/tableros/introduccion).

## Flujo recomendado

<Steps>
  <Step title="Consulta el esquema">
    Obtén los campos configurados y usa su `id` técnico en solicitudes y filtros.
  </Step>

  <Step title="Crea un contacto">
    Envía los datos que conoces respetando el tipo y las reglas de cada campo.
  </Step>

  <Step title="Guarda el ID">
    Conserva el `id` de la respuesta para consultar, actualizar o vincular el contacto.
  </Step>

  <Step title="Consulta o recorre contactos">
    Consulta un contacto por ID o usa el listado paginado para recorrer la colección.
  </Step>

  <Step title="Actualiza o elimina">
    Envía únicamente los campos que cambiaron. Elimina el contacto cuando ya no deba estar disponible.
  </Step>
</Steps>

## Campos del contacto

Cada cuenta define su propio esquema. Estos campos son comunes:

| Campo          | Tipo       | Descripción                |
| -------------- | ---------- | -------------------------- |
| `firstName`    | `string`   | Nombre.                    |
| `lastName1`    | `string`   | Primer apellido.           |
| `lastName2`    | `string`   | Segundo apellido.          |
| `email`        | `string`   | Correo electrónico válido. |
| `phoneNumbers` | `string[]` | Uno o más teléfonos.       |

Tu cuenta puede incluir campos adicionales. Usa el identificador técnico del campo como propiedad del JSON y respeta su tipo configurado.

<Warning>
  No envíes `id`, `createdAt` ni `updatedAt`. La API administra estos campos.
</Warning>

## Autenticación

Incluye tu API key en todas las solicitudes:

```http theme={null}
x-ib-api-key: <tu-api-key>
```

Consulta [Autenticación](/autenticacion) si todavía no tienes una clave.

## Operaciones

<Columns cols={2}>
  <Card title="Obtener esquema" icon="braces" href="/contactos/obtener-schema">
    Consulta los campos, tipos y valores permitidos.
  </Card>

  <Card title="Crear contacto" icon="user-plus" href="/contactos/crear-contacto">
    Agrega un contacto y obtén su ID.
  </Card>

  <Card title="Listar contactos" icon="list" href="/contactos/listar-contactos">
    Recorre contactos con paginación por cursor.
  </Card>

  <Card title="Buscar contactos" icon="search" href="/contactos/buscar-contactos">
    Combina filtros, ordenamiento y paginación por página.
  </Card>

  <Card title="Consultar contacto" icon="user-round-search" href="/contactos/consultar-contacto">
    Obtén un contacto por ID.
  </Card>

  <Card title="Actualizar contacto" icon="user-round-pen" href="/contactos/actualizar-contacto">
    Modifica únicamente los campos necesarios.
  </Card>

  <Card title="Eliminar contacto" icon="user-round-x" href="/contactos/eliminar-contacto">
    Retira un contacto de las consultas posteriores.
  </Card>
</Columns>
