Exportación masiva de entidades
curl --request POST \
--url http://api.gu1.ai/entities/export/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deliveryMode": "<string>",
"recipientEmails": [
"<string>"
],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": [
"<string>"
],
"fromSenderId": {},
"fromEmail": "<string>"
}
'import requests
url = "http://api.gu1.ai/entities/export/jobs"
payload = {
"deliveryMode": "<string>",
"recipientEmails": ["<string>"],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": ["<string>"],
"fromSenderId": {},
"fromEmail": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deliveryMode: '<string>',
recipientEmails: ['<string>'],
format: '<string>',
filters: {},
emailLocale: '<string>',
columns: ['<string>'],
fromSenderId: {},
fromEmail: '<string>'
})
};
fetch('http://api.gu1.ai/entities/export/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "http://api.gu1.ai/entities/export/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deliveryMode' => '<string>',
'recipientEmails' => [
'<string>'
],
'format' => '<string>',
'filters' => [
],
'emailLocale' => '<string>',
'columns' => [
'<string>'
],
'fromSenderId' => [
],
'fromEmail' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://api.gu1.ai/entities/export/jobs"
payload := strings.NewReader("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://api.gu1.ai/entities/export/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/entities/export/jobs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyExportación masiva de entidades
Encola un job asíncrono que exporta entidades filtradas a CSV, XLSX o JSON para descargar desde el historial y, opcionalmente, enviar por correo.
POST
/
entities
/
export
/
jobs
Exportación masiva de entidades
curl --request POST \
--url http://api.gu1.ai/entities/export/jobs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"deliveryMode": "<string>",
"recipientEmails": [
"<string>"
],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": [
"<string>"
],
"fromSenderId": {},
"fromEmail": "<string>"
}
'import requests
url = "http://api.gu1.ai/entities/export/jobs"
payload = {
"deliveryMode": "<string>",
"recipientEmails": ["<string>"],
"format": "<string>",
"filters": {},
"emailLocale": "<string>",
"columns": ["<string>"],
"fromSenderId": {},
"fromEmail": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deliveryMode: '<string>',
recipientEmails: ['<string>'],
format: '<string>',
filters: {},
emailLocale: '<string>',
columns: ['<string>'],
fromSenderId: {},
fromEmail: '<string>'
})
};
fetch('http://api.gu1.ai/entities/export/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "http://api.gu1.ai/entities/export/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'deliveryMode' => '<string>',
'recipientEmails' => [
'<string>'
],
'format' => '<string>',
'filters' => [
],
'emailLocale' => '<string>',
'columns' => [
'<string>'
],
'fromSenderId' => [
],
'fromEmail' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://api.gu1.ai/entities/export/jobs"
payload := strings.NewReader("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://api.gu1.ai/entities/export/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/entities/export/jobs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deliveryMode\": \"<string>\",\n \"recipientEmails\": [\n \"<string>\"\n ],\n \"format\": \"<string>\",\n \"filters\": {},\n \"emailLocale\": \"<string>\",\n \"columns\": [\n \"<string>\"\n ],\n \"fromSenderId\": {},\n \"fromEmail\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyResumen
Exporta entidades según los mismos filtros queGET /entities y genera un archivo (csv, xlsx o json). Con deliveryMode: "download_only" queda disponible en el historial sin enviar correo ni consumir créditos de email. Con deliveryMode: "email" también se envía a los destinatarios indicados. La respuesta es 202 con jobId.
Endpoint
POST http://api.gu1.ai/entities/export/jobs
Autenticación, permisos y marketplace
Siempre requiereAuthorization, X-Organization-ID y permiso entities:export. La integración global_sender_email, el remitente y el saldo solo se validan con deliveryMode: "email"; el cobro es por destinatario. El modo download_only no consume créditos de email.
Dominio y remitente
Misma semántica que el PDF por correo:fromEmail: dominio verificado en la org; no hace falta fila en Remitentes.fromSenderId: UUID enorganization_email_senders.- No enviar ambos a la vez.
Cuerpo JSON
string
download_only para dejar el archivo únicamente en el historial, o email para agregar el envío por correo. Por compatibilidad, si se omite y hay destinatarios, se interpreta como email.string[]
Obligatorio y no vacío con
deliveryMode: "email" (máx. 26 deduplicados). Debe ser [] con download_only.string
required
csv, xlsx o json.object
Filtros con la misma forma que el query de
GET /entities (búsqueda, fechas, tipo, etc.). Por defecto {}.string
en, es o pt para el correo de finalización cuando deliveryMode es email.string[]
Columnas snake_case del layout de exportación; omitir o
[] = todas las columnas permitidas.string (uuid)
Remitente por UUID. Solo aplica a
email y es excluyente con fromEmail.string
Remitente por dirección en dominio verificado. Solo aplica a
email y es excluyente con fromSenderId.Ejemplo sin correo
{
"deliveryMode": "download_only",
"recipientEmails": [],
"format": "xlsx",
"filters": {
"type": "person"
}
}
Ejemplo con correo
{
"deliveryMode": "email",
"recipientEmails": ["analista@ejemplo.com"],
"format": "xlsx",
"emailLocale": "es",
"fromEmail": "exportaciones@tu-dominio.com",
"filters": {
"search": "",
"type": "person"
}
}
Respuesta 202
{
"jobId": "uuid-del-job",
"status": "queued",
"deliveryMode": "download_only",
"message": "…"
}
Seguimiento del job
GET /entities/export/jobs— historial paginado de la organización.GET /entities/export/jobs/{jobId}— estado (queued,running,completed,completed_email_failed,failed) y modo de entrega.GET /entities/export/jobs/{jobId}/download— descarga autenticada mientras el archivo siga disponible.- Si falla un correo después de generar el archivo, el job queda como
completed_email_failedy todavía puede descargarse desde el historial.
fileExpiresAt. Es nullable: null
significa que el archivo guardado no caduca. linkExpiresAt es independiente e indica
únicamente cuándo deja de funcionar el enlace firmado enviado por correo. Los archivos
nuevos de exportaciones de entidades y transacciones no caducan y quedan disponibles en
el historial salvo que se eliminen de forma explícita.
Errores 400
Los errores de modo incluyenEXPORT_RECIPIENTS_REQUIRED, EXPORT_RECIPIENTS_NOT_ALLOWED y EXPORT_STORAGE_REQUIRED. Con deliveryMode: "email" también aplican los códigos de pre-flight de report-export-email, como dominio no verificado o saldo insuficiente.
Relacionado
- Informe PDF de una entidad por correo —
POST /entities/{id}/report-export/email.
Was this page helpful?