Imports

List

Returns the workspace's imports, both email imports and data dump imports, with the number of messages retrieved so far filled in for the email ones. Email imports left without email settings are silently skipped. Filtering, searching and sorting are applied in memory, 100 per page ordered by id ascending unless take, page and sort_by_key say otherwise.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/imports

Authorisation: Minimum role: USER

Request arguments

Name	Type	Source
filter	DTO_standard_filter	Query

Request body example

Response

Status: 200 (OK)
Type: DTO_import[]

Wrapper: DTO_response_wrap_get_many

Other statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

DTO_standard_filter

Name	Type	Description
sort_by_key	String	Sort by key
response_field_keys	String[]	Only return the fields specified
filters	String[]	Each string needs to be structured: filters=field_key:operator:value1\|value2\|value3 Only used to store filters for passing along as querystring
include_aggregations	Boolean	Include aggregations
include_imported	Boolean	Include imported
search	String	Search
sort_order	ENUM sort_order	Sort order
take	Int32	Take
page	Int32	Page

DTO_import

Name	Type	ReadOnly	Description
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
group	DTO_reference		Group
email	DTO_import_email		Email
data_dump	DTO_import_data_dump		Data dump
id	Int32	ReadOnly	Leave empty on input
friendly_name	String		Friendly name
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated
type	ENUM import_type		Type

DTO_reference_user

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

DTO_reference

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

DTO_import_email

Name	Type	ReadOnly	Description
imap	DTO_external_auth_imap		Imap
oauth2	DTO_external_auth_oauth2		Oauth2
mailbox	String		Leave empty for current user
mailbox_folder_name	String		Mailbox folder name
total_message_count	Int32	ReadOnly	Total message count
retrieved_count	Int32	ReadOnly	Retrieved count
status	ENUM import_email_status	ReadOnly	Status

DTO_external_auth_imap

Name	Type	Description
hostname	String	Hostname
port	Int32	Port
username	String	Username
password	String	Password

DTO_external_auth_oauth2

Name	Type	ReadOnly	Description
identifier	String		Identifier
authorized_account	String	ReadOnly	Authorized account

DTO_import_data_dump

Name	Type	ReadOnly	Description
total_count	Int32		Total count
provider	ENUM import_data_dump_provider		Provider

ENUM import_email_status

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	IN_PROGRESS	In progress
2	DONE	Done
3	ERROR	Error

ENUM import_data_dump_provider

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	GROOVEHQ	GrooveHQ
2	EXCEL_QA	Excel Q&A
3	EXCEL_QUESTIONNAIRE	Excel Questionnaire
4	SUPPORT_BOX_EML	SupportBox EML

ENUM sort_order

Value	Name	Description
0	ASC	ASC
1	DESC	DESC

ENUM import_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	EMAIL	Email
2	DATA_DUMP	Data dump

Generated Aug 4, 2026 18:37