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
| Name | Type | Required | Description |
|---|---|---|---|
| string | no | Email is the Atlassian account the Jira API token was issued to. Unused for ClickUp and Trello. | |
| key | string | no | Key is the Trello API key. Unused for ClickUp. |
| oauth | boolean | no | OAuth 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. |
| site | string | no | Site is the Jira Cloud site URL ("https://acme.atlassian.net"). Unused for ClickUp and Trello. |
| source | string | no | "clickup" | "trello" | "jira" |
| token | string | no | Token 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Import ID |
Responses
- 200 OK · apimodel.Envelope
- 404 Not Found · apimodel.ErrorEnvelope
post /imports/{id}/cancel
Cancel an import
Requires authentication
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Import ID |
Responses
- 204 No Content
- 404 Not Found · apimodel.ErrorEnvelope
get /imports/{id}/events
Stream import progress
Requires authentication
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Import ID |
Responses
- 200 OK
- 404 Not Found · apimodel.ErrorEnvelope
post /imports/{id}/mapping
Apply import mapping and begin writing
Requires authentication
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | yes | Import ID |
Request body: domain.ImportOptions
| Name | Type | Required | Description |
|---|---|---|---|
| checklistsAsSubtasks | boolean | no | ChecklistsAsSubtasks 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. |
| createColumns | map<domain.ProjectColumn[]> | no | CreateColumns are columns the wizard wants created on the target project, keyed by scope external id. |
| fieldMappings | domain.ImportFieldMapping[] | no | |
| importArchived | boolean | no | ImportArchived brings archived tasks over, marked resolved. |
| importAttachments | boolean | no | ImportAttachments downloads and re-hosts source attachments. Separable because attachments dominate both wall-clock time and storage quota. |
| personMappings | domain.ImportPersonMapping[] | no | |
| scopeNames | map<string> | no | ScopeNames overrides the target project name per scope. |
| scopes | string[] | no | Scopes selected for import, by external id. |
| skipClosedBefore | string | no | SkipClosedBefore 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. |
| statusMappings | domain.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
| Name | Type | Required | Description |
|---|---|---|---|
| token | string | no | Token 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