Skip to content

All resources

imports

8 endpoints

get /imports

List imports

Requires authentication

Responses

  • 200 OK · apimodel.Envelope

post /imports

Start an import

Requires authentication

Request body: handler.StartImportRequest

NameTypeRequiredDescription
emailstringnoEmail is the Atlassian account the Jira API token was issued to. Unused for ClickUp and Trello.
keystringnoKey is the Trello API key. Unused for ClickUp.
oauthbooleannoOAuth marks a ClickUp OAuth token rather than a personal one. It changes the wire format: personal tokens go in a bare Authorization header, OAuth tokens need a "Bearer " prefix.
sitestringnoSite is the Jira Cloud site URL ("https://acme.atlassian.net"). Unused for ClickUp and Trello.
sourcestringno"clickup" | "trello" | "jira"
tokenstringnoToken is the ClickUp personal/OAuth token, the Trello user token, or the Jira Cloud API token.

Responses

  • 201 Created · apimodel.Envelope
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope
  • 422 Unprocessable Entity · apimodel.ErrorEnvelope

get /imports/{id}

Get an import

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesImport ID

Responses

  • 200 OK · apimodel.Envelope
  • 404 Not Found · apimodel.ErrorEnvelope

post /imports/{id}/cancel

Cancel an import

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesImport ID

Responses

  • 204 No Content
  • 404 Not Found · apimodel.ErrorEnvelope

get /imports/{id}/events

Stream import progress

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesImport ID

Responses

  • 200 OK
  • 404 Not Found · apimodel.ErrorEnvelope

post /imports/{id}/mapping

Apply import mapping and begin writing

Requires authentication

Parameters

NameInTypeRequiredDescription
idpathintegeryesImport ID

Request body: domain.ImportOptions

NameTypeRequiredDescription
checklistsAsSubtasksbooleannoChecklistsAsSubtasks promotes checklist items to real sub-tasks instead of rendering them as markdown checkboxes in the description. Off by default: a Trello checklist item is not a task -- it has no comments and no attachments -- so promoting them inflates task counts for no gain.
createColumnsmap<domain.ProjectColumn[]>noCreateColumns are columns the wizard wants created on the target project, keyed by scope external id.
fieldMappingsdomain.ImportFieldMapping[]no
importArchivedbooleannoImportArchived brings archived tasks over, marked resolved.
importAttachmentsbooleannoImportAttachments downloads and re-hosts source attachments. Separable because attachments dominate both wall-clock time and storage quota.
personMappingsdomain.ImportPersonMapping[]no
scopeNamesmap<string>noScopeNames overrides the target project name per scope.
scopesstring[]noScopes selected for import, by external id.
skipClosedBeforestringnoSkipClosedBefore drops resolved tasks last touched before this instant. A five-year-old workspace is mostly closed tasks, and since runtime is dominated by the source's rate limit this is the biggest lever the operator has over how long the import takes.
statusMappingsdomain.ImportStatusMapping[]no

Responses

  • 200 OK · apimodel.Envelope
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope

post /imports/file

Start an import from a board export file

Requires authentication

Request body: handler.StartImportFileRequest

NameTypeRequiredDescription
tokenstringnoToken is the file's token from POST /public-tools/board-files ("f_...").

Responses

  • 201 Created · apimodel.Envelope
  • 400 Bad Request · apimodel.ErrorEnvelope
  • 404 Not Found · apimodel.ErrorEnvelope
  • 409 Conflict · apimodel.ErrorEnvelope

get /imports/sources

List available import sources

Requires authentication

Responses

  • 200 OK · apimodel.Envelope