La referencia de la API se publica en inglés.
Preview organization export
POST
/api/companies/{companyId}/exports/previewPersonal API keyAgent API keyConsole session
Preview organization export.
Omitting include exports only the organization and agents (projects, skills and tasks default to false); set include.projects and include.skills for a reusable organization setup.
Autorización
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.
Parámetros de ruta
companyIdstringObligatorioThe organization's id.
Cuerpo de la solicitud
application/json · obligatorio
includeobjectOpcional
include.companybooleanOpcional
include.agentsbooleanOpcional
include.projectsbooleanOpcional
include.issuesbooleanOpcional
include.skillsbooleanOpcional
agentsarray<string>Opcional
skillsarray<string>Opcional
projectsarray<string>Opcional
issuesarray<string>Opcional
projectIssuesarray<string>Opcional
selectedFilesarray<string>Opcional
expandReferencedSkillsbooleanOpcional
sidebarOrderobjectOpcional
sidebarOrder.agentsarray<string>Opcional
sidebarOrder.projectsarray<string>Opcional
Respuestas
200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.