On this page

Export Contacts

Operation overview

POST/v3/marketing/contacts/exports

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

Use this endpoint to export lists or segments of contacts.

If you would just like to have a link to the exported list sent to your email set the notifications.email option to true in the POST payload.

If you would like to download the list, take the id that is returned and use the "Export Contacts Status" endpoint to get the urls. Once you have the list of URLs, make a GET request to each URL provided to download your CSV file(s).

You specify the segments and or/contact lists you wish to export by providing the relevant IDs in, respectively, the segment_ids and list_ids fields in the request body.

The lists will be provided in either JSON or CSV files. To specify which of these you would required, set the request body file_type field to json or csv.

You can also specify a maximum file size (in MB). If the export file is larger than this, it will be split into multiple files.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Request body

Encoding type:application/json

Schema

Property nameTypeRequiredDescriptionChild properties

list_idsarray[string<uuid>]Optional

IDs of the contact lists you want to export.

segment_idsarray[string]Optional

IDs of the contact segments you want to export.

notificationsobjectOptional

Show child properties for notifications

file_typeenum<string>Optional

File type for export file. Choose from json or csv.

Default: csvPossible values:

csvjson

max_file_sizeintegerOptional

The maximum size of an export file in MB. Note that when this option is specified, multiple output files may be returned from the export.

Default: 5000

Responses

202400401403404500

Schema

Property nameTypeRequiredDescriptionChild properties

_metadataobject

Show child properties for _metadata

idstring

The ID of the export job.

Export Contacts

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
5const request = {
6  url: `/v3/marketing/contacts/exports`,
7  method: 'POST',
8  
9}
10
11client.request(request)
12  .then(([response, body]) => {
13    console.log(response.statusCode);
14    console.log(response.body);
15  })
16  .catch(error => {
17    console.error(error);
18  });