Listar contactos

GEThttps://api.bydomu.com/v1/contacts

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Contactos de la organización con filtros y paginación por página o por cursor (pageSize máximo 500). Los filtros que aceptan varios valores (status, source, type, tagIds) van separados por comas.

Permissão

contacts:read

Chaves

Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório

Sua chave secreta.

Parâmetros de consulta

pageinteger

Página, desde 1 · default=1 · ≥ 1

pageSizeinteger

Contactos por página (máximo 500) · default=20 · 1–500

cursorstring

Paginación por cursor: el meta.nextCursor de la respuesta anterior

includeTotalboolean | string

false para no contar el total (más rápido)

sortBystring

Campo de orden · default="createdAt"

sortOrderstring

Dirección del orden ascdesc · default="desc"

searchstring

Nombre, teléfono, correo o código

statusstring[]

Estados, separados por comas · nullable

archivedstring

true para ver solo los archivados truefalse

sourcestring[]

Fuentes de captación, separadas por comas · nullable

typestring[]

Tipos, separados por comas · nullable

ownerIdstring

Agente dueño del contacto

scoreMininteger

Puntaje mínimo (0-100) · 0–100 · nullable

scoreMaxinteger

Puntaje máximo (0-100) · 0–100 · nullable

createdAfterstring

Creados desde esta fecha (ISO 8601)

createdBeforestring

Creados hasta esta fecha (ISO 8601)

lastActivityBeforestring

Sin actividad desde esta fecha (ISO 8601): leads fríos

tagIdstring

Obsoleto: usa tagIds

tagIdsstring[]

IDs de etiqueta, separados por comas · nullable

hasDealsstring

Con (true) o sin (false) negocios truefalse

awaitingReplystring

true: el cliente escribió de último en una conversación abierta true

relationstring

Relación viva con la inmobiliaria ACTIVETENANTOWNERNEGOTIATINGTALKING

Respostas

200Página de contactos

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

{ "data": [ { "id": "clx1con001", "code": "C-0107", "firstName": "María", "lastName": "González", "email": "[email protected]", "phone": "+573001234567", "phone2": "+573109876543", "source": "WHATSAPP", "status": "NEW", "type": "CLIENT", "documentType": "CC", "documentNumber": "1020304050", "score": 75, "notes": "Busca apartamento cerca al trabajo.", "budget": "350000000.00", "currency": "COP", "lookingFor": "Apartamento de 3 habitaciones", "preferredType": "APARTMENT", "preferredCity": "Bogotá", "preferredNeighborhood": "Chapinero", "minBedrooms": 3, "minBathrooms": 2, "minArea": 70, "preferredTransactionType": "SALE", "subscribedToAlerts": true, "whatsappOptIn": true, "marketingOptIn": false, "ownerId": "clx1usr001", "createdAt": "2026-01-15T14:30:00.000Z", "updatedAt": "2026-09-20T09:15:00.000Z", "owner": { "id": "clx1usr001", "firstName": "Carlos", "lastName": "Rodríguez" }, "tags": [ { "contactId": "clx1con001", "tagId": "clx1tag001", "tag": { "id": "clx1tag001", …