Export Contacts

Export contact data

Manage contact exports

Create Contact Export

post

Create a new Contact Export

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

Body

application/json

Responses

201

Contact Export created successfully.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

422

Returns validation errors.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

post

/api/accounts/{account_id}/contacts/exports

cURLNode.jsPHPPythonC#Java

curl -X POST https://mailtrap.io/api/accounts/{account_id}/contacts/exports \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"filters": [{"name": "list_id", "operator": "equal", "value": [1, 2]}]}'

{
  "id": 1,
  "status": "started",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "url": null
}

Get Contact Export

get

Get Contact Export

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

export_idinteger · int64Required

Unique Contact Export ID

Example: 3229

Responses

200

OK.

application/json

idintegerOptional

statusstring · enumOptionalPossible values:

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

urlstring · uri · nullableOptional

The URL of the exported contacts file. Only available when the export is finished.

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

get

/api/accounts/{account_id}/contacts/exports/{export_id}

cURLNode.jsPHPPythonC#Java

curl -X GET https://mailtrap.io/api/accounts/{account_id}/contacts/exports/{export_id} \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

{
  "id": 1,
  "status": "started",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "url": null
}