La référence de l'API est publiée en anglais.

Preview organization export

POST/api/companies/{companyId}/exports/preview
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

includeobjectFacultatif
include.companybooleanFacultatif
include.agentsbooleanFacultatif
include.projectsbooleanFacultatif
include.issuesbooleanFacultatif
include.skillsbooleanFacultatif
agentsarray<string>Facultatif
skillsarray<string>Facultatif
projectsarray<string>Facultatif
issuesarray<string>Facultatif
projectIssuesarray<string>Facultatif
selectedFilesarray<string>Facultatif
expandReferencedSkillsbooleanFacultatif
sidebarOrderobjectFacultatif
sidebarOrder.agentsarray<string>Facultatif
sidebarOrder.projectsarray<string>Facultatif

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Organizations