Справочник API публикуется на английском языке.
Export an organization (legacy singular form)
POST
/api/companies/{companyId}/exportPersonal API keyAgent API keyConsole session
Export an organization (legacy singular form).
Авторизация
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. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
includeobjectНеобязательный
include.companybooleanНеобязательный
include.agentsbooleanНеобязательный
include.projectsbooleanНеобязательный
include.issuesbooleanНеобязательный
include.skillsbooleanНеобязательный
agentsarray<string>Необязательный
skillsarray<string>Необязательный
projectsarray<string>Необязательный
issuesarray<string>Необязательный
projectIssuesarray<string>Необязательный
selectedFilesarray<string>Необязательный
expandReferencedSkillsbooleanНеобязательный
sidebarOrderobjectНеобязательный
sidebarOrder.agentsarray<string>Необязательный
sidebarOrder.projectsarray<string>Необязательный
Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.