Export organization data

POST/api/companies/{companyId}/exports
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Export organization data.

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.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

includeobjectOptional
include.companybooleanOptional
include.agentsbooleanOptional
include.projectsbooleanOptional
include.issuesbooleanOptional
include.skillsbooleanOptional
agentsarray<string>Optional
skillsarray<string>Optional
projectsarray<string>Optional
issuesarray<string>Optional
projectIssuesarray<string>Optional
selectedFilesarray<string>Optional
expandReferencedSkillsbooleanOptional
sidebarOrderobjectOptional
sidebarOrder.agentsarray<string>Optional
sidebarOrder.projectsarray<string>Optional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Organizations