HTTP API: export
The 16 operations tagged export, each with its parameters, its body and what it answers.
Export the comments you can read
GET /v1/export/comments
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Comment_. Successful Response422:HTTPValidationError. Validation Error
Export the documents you can read
GET /v1/export/documents
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Document_. Successful Response422:HTTPValidationError. Validation Error
Export the events you can read
GET /v1/export/events
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Event_. Successful Response422:HTTPValidationError. Validation Error
Export the item types you can read
GET /v1/export/item_types
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_ItemType_. Successful Response422:HTTPValidationError. Validation Error
Export the link types you can read
GET /v1/export/link_types
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_LinkType_. Successful Response422:HTTPValidationError. Validation Error
Export the links you can read
GET /v1/export/links
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Edge_. Successful Response422:HTTPValidationError. Validation Error
Export the members you can read
GET /v1/export/members
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Member_. Successful Response422:HTTPValidationError. Validation Error
Export the project members you can read
GET /v1/export/project_members
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_ProjectMember_. Successful Response422:HTTPValidationError. Validation Error
Export the projects you can read
GET /v1/export/projects
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Project_. Successful Response422:HTTPValidationError. Validation Error
Export the saved views you can read
GET /v1/export/saved_views
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_SavedView_. Successful Response422:HTTPValidationError. Validation Error
Export the statuses you can read
GET /v1/export/statuses
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Status_. Successful Response422:HTTPValidationError. Validation Error
Export the tags you can read
GET /v1/export/tags
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_TagEntry_. Successful Response422:HTTPValidationError. Validation Error
Export the tasks you can read
GET /v1/export/tasks
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Task_. Successful Response422:HTTPValidationError. Validation Error
Export the users you can read
GET /v1/export/users
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_User_. Successful Response422:HTTPValidationError. Validation Error
Export the verifications you can read
GET /v1/export/verifications
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Verification_. Successful Response422:HTTPValidationError. Validation Error
Export the workspace you can read
GET /v1/export/workspace
Return everything of this kind you can read in a workspace, a page at a time.
Each item is the object the API returns for it everywhere else. Done, archived and
deleted items are included, and so are the templates repeating items are made from; a
private project you are not a member of is not, nor anything in it. Follow
next_cursor until has_more is false, and the pages together are the whole of it.
Parameters
workspace_id(stringornull, in query): Which workspace, by id or short name. Needed when you can reach several.limit(integerornull, in query): How many to return. At least 1; capped at the instance's max_page_size.cursor(stringornull, in query): Continue after a previous page.
Responses
200:Collection_Workspace_. Successful Response422:HTTPValidationError. Validation Error