curl --request GET 'https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000?type=REPORT&exportFormat=pdf' \
--header 'Authorization: Bearer SEU_TOKEN'
curl --request GET 'https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000?type=REPORT§ionOrder=LOCATION§ionOrder=SUMMARY§ionOrder=PEFIN' \
--header 'Authorization: Bearer SEU_TOKEN'
const url = new URL("https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000");
url.searchParams.set("type", "REPORT");
url.searchParams.set("exportFormat", "pdf");
const resposta = await fetch(url, { headers: { Authorization: `Bearer ${token}` } });
const dados = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000",
headers={"Authorization": f"Bearer {token}"},
params={"type": "REPORT", "exportFormat": "pdf"},
)
dados = resposta.json()
{
"status": "processing",
"reportId": "6612a7f3a19b467000000000"
}
{
"code": 400,
"message": "type must be one of the following values: REPORT, REPORT_MINIFIED,type should not be empty"
}
Referência da API
Exportar Relatório (Assíncrono)
Pede a geração do PDF ou do Excel do relatório. O link chega pelo webhook REPORT_EXPORTED.
GET
/
report
/
export
/
{id}
curl --request GET 'https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000?type=REPORT&exportFormat=pdf' \
--header 'Authorization: Bearer SEU_TOKEN'
curl --request GET 'https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000?type=REPORT§ionOrder=LOCATION§ionOrder=SUMMARY§ionOrder=PEFIN' \
--header 'Authorization: Bearer SEU_TOKEN'
const url = new URL("https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000");
url.searchParams.set("type", "REPORT");
url.searchParams.set("exportFormat", "pdf");
const resposta = await fetch(url, { headers: { Authorization: `Bearer ${token}` } });
const dados = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000",
headers={"Authorization": f"Bearer {token}"},
params={"type": "REPORT", "exportFormat": "pdf"},
)
dados = resposta.json()
{
"status": "processing",
"reportId": "6612a7f3a19b467000000000"
}
{
"code": 400,
"message": "type must be one of the following values: REPORT, REPORT_MINIFIED,type should not be empty"
}
Quando usar
Use esta rota para gerar o arquivo do relatório sem segurar a conexão. A resposta volta na hora com202, e o link do arquivo chega pelo webhook REPORT_EXPORTED (um disparo por arquivo gerado). Para receber o link na própria resposta, use Exportar Relatório (Síncrono).
Autenticação
Bearer JWT no headerAuthorization.
Parâmetros
| Nome | Local | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
id | path | string | sim | ID do relatório. |
type | query | string | sim | REPORT ou REPORT_MINIFIED. Use REPORT. Sem o parâmetro, a resposta é 400. |
exportFormat | query | string | não | pdf (padrão), excel ou both. Com both, saem dois arquivos e dois webhooks. |
sectionOrder | query | string[] | não | Seções do arquivo, na ordem desejada. Repita o parâmetro para cada seção: sectionOrder=LOCATION§ionOrder=SUMMARY. Só as seções listadas entram. |
templateId | query | string | não | ID de um modelo de exportação da organização. |
systemTemplate | query | string | não | Modelo nativo: COMPLETE ou COMPACT. |
sectionOrder, valem as seções e a ordem do modelo: o escolhido em templateId ou systemTemplate, senão o modelo padrão da organização, senão o padrão do sistema. O nível de detalhe do PDF (completo ou compacto) vem sempre do modelo, mesmo quando você manda sectionOrder.
Um relatório inexistente ou de outra organização não é recusado na resposta: o
202 volta normalmente e a falha chega pelo webhook REPORT_EXPORTED, com exportUrl nulo e o campo error.curl --request GET 'https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000?type=REPORT&exportFormat=pdf' \
--header 'Authorization: Bearer SEU_TOKEN'
curl --request GET 'https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000?type=REPORT§ionOrder=LOCATION§ionOrder=SUMMARY§ionOrder=PEFIN' \
--header 'Authorization: Bearer SEU_TOKEN'
const url = new URL("https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000");
url.searchParams.set("type", "REPORT");
url.searchParams.set("exportFormat", "pdf");
const resposta = await fetch(url, { headers: { Authorization: `Bearer ${token}` } });
const dados = await resposta.json();
import requests
resposta = requests.get(
"https://gyra-core.gyramais.com.br/report/export/6612a7f3a19b467000000000",
headers={"Authorization": f"Bearer {token}"},
params={"type": "REPORT", "exportFormat": "pdf"},
)
dados = resposta.json()
{
"status": "processing",
"reportId": "6612a7f3a19b467000000000"
}
{
"code": 400,
"message": "type must be one of the following values: REPORT, REPORT_MINIFIED,type should not be empty"
}
O que chega no webhook
{
"organizationId": "6612a7f3fa9e086b00000000",
"webhookType": "REPORT_EXPORTED",
"data": {
"reportId": "6612a7f3a19b467000000000",
"exportUrl": "https://exemplo.gyramais.com.br/relatorio.pdf",
"exportedAt": "2026-07-31T18:03:37.464Z"
}
}
exportUrl (PDF) e exportExcelUrl (Excel). O link do Excel expira em 7 dias.
