v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB

Import

List Imports

Retrieve a list of imports

get/import

Query parameters

idstring

Import ID

created_atstring

Import creation date

updated_atstring

Latest update

organisation_idstring

Organisation ID

typestring

Type of import

payloadstring

Payload of import for small imports

contact_list_idstring

ID of the contact list that the contacts should be assigned to

contact_list_external_idstring

External ID of the contact list that the contacts should be assigned to

failed_urlstring

URL to download the failed contacts

payload_urlstring

URL to download the payload for large imports

total_countstring

Total number of contacts in the import

success_countstring

Number of contacts successfully imported

failed_countstring

Number of contacts that failed to import

reference_idstring

An optional reference ID provided during the import

hintsstring

Optional hints for the import, e.g. to indicate if a field was stolen from another contact. We only store the first 20 hints.

allow_deal_reassignmentstring

If true, a deal currently assigned to another contact will be re-assigned

allow_appointment_reassignmentstring

If true, an appointment currently assigned to another contact will be re-assigned

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: created_at

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

idstring uuid

Import ID

created_atstring timestamp with time zone

Import creation date

updated_atstring timestamp with time zone

Latest update

organisation_idstring uuid

Organisation ID

type'contact_details' | 'deal_details' | 'appointment_details' public.import_type

Type of import

payloadobject nullable

Payload of import for small imports

contact_list_idstring uuid nullable

ID of the contact list that the contacts should be assigned to

contact_list_external_idstring text nullable

External ID of the contact list that the contacts should be assigned to

failed_urlstring text nullable

URL to download the failed contacts

payload_urlstring text nullable

URL to download the payload for large imports

total_countinteger nullable

Total number of contacts in the import

success_countinteger nullable

Number of contacts successfully imported

failed_countinteger nullable

Number of contacts that failed to import

reference_idstring text nullable

An optional reference ID provided during the import

hintsobject nullable

Optional hints for the import, e.g. to indicate if a field was stolen from another contact. We only store the first 20 hints.

allow_deal_reassignmentboolean nullable

If true, a deal currently assigned to another contact will be re-assigned

allow_appointment_reassignmentboolean nullable

If true, an appointment currently assigned to another contact will be re-assigned