Skip to main content
List Imports
curl --request GET \
  --url https://integration.getmateo.com/api/v1/import \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "random uuid",
    "created_at": "now()",
    "updated_at": "now()",
    "organisation_id": "random uuid",
    "type": "contact_details",
    "payload": {},
    "contact_list_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "failed_url": "<string>",
    "payload_url": "<string>",
    "total_count": 123,
    "success_count": 123,
    "failed_count": 123,
    "reference_id": "<string>",
    "hints": {}
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Range
string

Limiting and Pagination

​
Range-Unit
string
default:items

Limiting and Pagination

Query Parameters

​
id
string

Import ID

​
created_at
string

Import creation date

​
updated_at
string

Latest update

​
organisation_id
string

Organisation ID

​
type
string

Type of import

​
payload
string

Payload of import for small imports

​
contact_list_id
string

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

​
failed_url
string

URL to download the failed contacts

​
payload_url
string

URL to download the payload for large imports

​
total_count
string

Total number of contacts in the import

​
success_count
string

Number of contacts successfully imported

​
failed_count
string

Number of contacts that failed to import

​
reference_id
string

An optional reference ID provided during the import

​
hints
string

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

​
select
string

Filtering Columns

​
order
string

Ordering

​
offset
string

Limiting and Pagination

​
limit
string

Limiting and Pagination

Response

200 - application/json

OK

​
id
string<uuid>
default:random uuid

Import ID

​
created_at
string<timestamp with time zone>
default:now()

Import creation date

​
updated_at
string<timestamp with time zone>
default:now()

Latest update

​
organisation_id
string<uuid>
default:random uuid

Organisation ID

​
type
enum<string>

Type of import

Available options:
contact_details,
deal_details,
appointment_details
​
payload
object | null

Payload of import for small imports

​
contact_list_id
string<uuid> | null

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

​
failed_url
string<text> | null

URL to download the failed contacts

​
payload_url
string<text> | null

URL to download the payload for large imports

​
total_count
integer | null

Total number of contacts in the import

​
success_count
integer | null

Number of contacts successfully imported

​
failed_count
integer | null

Number of contacts that failed to import

​
reference_id
string<text> | null

An optional reference ID provided during the import

​
hints
object | null

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