Listar secuencias

GET /api/v1/sequences Cada secuencia lleva id, name, status, publishedVersionId y sus fechas.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERPermitido
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Parámetros de consulta

ParámetroTipoDescripción
pagenumberNúmero de página, por defecto 1
limitnumberElementos por página, máximo 100

Parámetros de consulta

ParámetroTipoDescripción
statusstringactive o paused
searchstringCoincide con el nombre
pagenumberPor defecto 1
limitnumberPor defecto 20, máximo 100

Ejemplo

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/sequences?page=1&limit=20"

Respuesta

  • 200 OK: la llamada tuvo éxito.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

data es un array de secuencias, con un objeto pagination al lado.
CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data[].idstringIdentificador de la secuencia
data[].namestringSu nombre
data[].statusstringactive o paused
data[].publishedVersionIdstring \null
data[].topicIdstring | nullEl tema editorial que lleva, si lo hay
data[].createdAt / updatedAtstringFechas ISO
paginationobject{total, page, limit, totalPages}

Ejemplo de respuesta

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "name": "Newsletter",
      "status": "subscribed",
      "publishedVersionId": "c41a7e55",
      "createdAt` / `updatedAt": "value"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Relacionado