Listar tareas

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

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.

Tareas de toda la organización con filtros y paginación por página o por cursor (pageSize máximo 500). Por defecto solo las no archivadas. status, type y priority aceptan varios valores separados por comas.

Permissão
tasks: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
Tareas 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
Texto en el título, o prefijo del ID
assigneeIdstring
Responsable
createdByIdstring
Quién la creó
statusstring[]
Estados, separados por comas. OVERDUE = abiertas con fecha vencida · nullable
typestring[]
Tipos, separados por comas · nullable
prioritystring[]
Prioridades, separadas por comas · nullable
dateFromstring
Vencen desde esta fecha (ISO 8601) · nullable
dateTostring
Vencen hasta esta fecha (ISO 8601) · nullable
dueDateModestring
Solo con fecha (WITH_DATE) o sin fecha (WITHOUT_DATE) WITH_DATEWITHOUT_DATE
dueSoonboolean
Abiertas que vencen en las próximas 48 h. Cualquier valor no vacío (incluso false) cuenta como verdadero · nullable
archivedboolean
SOLO las archivadas. Cualquier valor no vacío (incluso false) cuenta como verdadero: para las vivas, omítelo · nullable

Respostas

200Página de tareas
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.
cURL
curl "https://api.bydomu.com/v1/tasks" \
  -H "X-API-Key: $BYDOMU_API_KEY"
JavaScript
const res = await fetch("https://api.bydomu.com/v1/tasks", {
  headers: { "X-API-Key": process.env.BYDOMU_API_KEY },
});
const data = await res.json();
Python
import os, requests

r = requests.get(
    "https://api.bydomu.com/v1/tasks",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}
)
data = r.json()
Resposta · 200 · exemplo
{
  "data": [
    {
      "id": "clx1tsk001",
      "title": "Llamar a María para confirmar la visita",
      "description": "Confirmar el jueves a las 10.",
      "type": "CALL",
      "status": "PENDING",
      "priority": "LOW",
      "dueDate": "2026-10-01T15:00:00.000Z",
      "completedAt": "2026-10-01T14:40:00.000Z",
      "archivedAt": "2026-10-15T00:00:00.000Z",
      "attachments": [],
      "dealId": "clx1deal001",
      "contactId": "clx1con001",
      "assigneeId": "clx1usr001",
      "createdById": "clx1usr002",
      "createdAt": "2026-09-25T10:00:00.000Z",
      "updatedAt": "2026-09-25T10:00:00.000Z",
      "assignee": {
        "id": "clx1usr001",
        "firstName": "Carlos",
        "lastName": "Rodríguez",
        "avatarUrl": "https://cdn.bydomu.com/avatars/carlos.jpg"
      },
      "createdBy": {
        "id": "clx1usr001",
        "firstName": "Carlos",
        "lastName": "Rodríguez"
      },
      "deal": {
        "id": "clx1deal001",
        "title": "Venta Apto Chapinero",
        "contact": {
          "id": "clx1con001",
          "firstName": "María",
          "lastName": "González"
        }
      },
      "contact": {
        "id": "clx1con001",
        "firstName": "María",
        "lastName": "González"
      },
  …

A chave vai na variável BYDOMU_API_KEY. Os dados do exemplo não são de nenhuma imobiliária.