Descargar el archivo de un trabajo

GET/v1/jobs/{id}/file

Para desarrolladores

Descripción

Descarga el archivo que dejó un trabajo completado, para los tipos de trabajo que dejan uno. Hoy es list_export, cuyo archivo es un CSV con los datos de una lista (POST /v1/lists/{id}/export).

Autenticación

Authorizationbearer tokenheaderobligatorio

Formato: Bearer <API_KEY>.

X-Instance-Slugstringheaderobligatorio

Identificador de su instancia. Ver Autenticación.

Scope requerido: el de lectura del recurso sobre el que trabaja; list:read para los trabajos de listas.

Request

Path params:

idstring (UUID)obligatorio

Identificador del trabajo.

Response

200 OKDevuelve el archivo como un CSV adjunto (text/csv; charset=utf-8). Su nombre viene en Content-Disposition: lista-{list_id}-{YYYYMMDD-HHMMSS}.csv, con la fecha en que terminó la exportación. Las columnas son las de la lista exportada (ver POST /v1/lists/{id}/export).text/csv

Los campos de la lista

Una columna por campo, en el orden de las columnas de la lista, con el nombre del campo como encabezado. Después de la cabecera, una fila por contacto.

Errores

Código	Cuándo
404	El trabajo no existe, o la API key no tiene el scope de lectura de su recurso (job_not_found). El tipo del trabajo no deja archivo, o el trabajo falló (job_file_not_found). La lista que exportó fue eliminada (list_not_found).
409	El trabajo todavía no terminó (job_not_completed). Siga el trabajo en GET /v1/jobs/{id} hasta que su status sea completed.
410	El archivo venció y ya no se puede descargar (job_file_expired). Pida una exportación nueva.
422	id no es un UUID.

Detalle completo en Respuestas de error.

Notas

• El archivo se puede descargar hasta la fecha de result.expires_at del trabajo, todas las veces que haga falta. Después de esa fecha, la descarga responde 410.
• Cada descarga queda registrada en el log de actividad de la instancia, como cualquier exportación de datos de contactos.

Request

curl -X GET "https://$API_HOST/v1/jobs/01a14d2e-7c31-7f02-9b6e-4d5c6b7a8e9f/file" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG" \
-o lista.csv

Response

Correo,Nombre,Plan
[email protected],Ana,oro
[email protected],Beto,