Skip to main content
GET
Listar contactos

Autorizaciones

x-api-key
string
header
requerido

API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).

x-authorization-token
string
header
requerido

Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...

Parámetros de consulta

name
string

Búsqueda parcial por nombre

email
string

Filtrar por email exacto

phone
string

Filtrar por número de teléfono

contactCode
string

ID público del contacto, con prefijo con_ o sin él. Match exacto.

identifier
string

Busca por cualquier identificador del contacto (externalClientId o secundario, ej. referencia de efectivo). Match exacto.

externalClientId
string

Filtrar por llave externa exacta. Es el mismo filtro que identifier: si envías los dos con valores distintos, la API responde 400.

page
integer
predeterminado:1
Rango requerido: x >= 1
limit
integer
predeterminado:50
Rango requerido: 1 <= x <= 500

Respuesta

Lista de contactos

data
object[]
meta
object

Metadatos de paginación. page default 1; limit default 50, máximo 500. Valores inválidos de page o limit toman el default (no dan 400) y un limit mayor a 500 se recorta a 500; meta.limit refleja el valor aplicado.

requestId
string