Export a contact's profile as XLSX

GET

/api/v3/contacts/{email}/export

const url = 'https://api.tryletterhead.com/api/v3/contacts/example/export?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/contacts/example/export?api=true' \
  --header 'Authorization: Bearer <token>'

Downloads a multi-sheet Excel workbook of everything visible on the contact’s profile — their details, subscriptions, tags, custom fields, engagement summary, and full activity history.

This is a company-level (v3) read. Authenticate with a company API key as a Bearer token.

Authorizations

bearerAuth

Parameters

Path Parameters

email

required

string

The contact’s email address, URL-encoded.

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

The XLSX file, returned as the response body with a Content-Disposition: attachment header.

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string format: binary

Still can’t find what you need? Contact support.