Skip to contentSkip to navigationSkip to topbar
On this page

Get Sample Contacts



Operation overview

operation-overview page anchor

GET/v3/marketing/contacts

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

This endpoint will return up to 50 of the most recent contacts uploaded or attached to a list.

This list will then be sorted by email address.

The full contact count is also returned.

Please note that pagination of the contacts has been deprecated.

Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
200400401403404500
Schema
Property nameTypeRequiredDescriptionChild properties
resultarray[object]

_metadataobject

contact_countinteger
Get Sample ContactsLink to code sample: Get Sample Contacts
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
5
const request = {
6
url: `/v3/marketing/contacts`,
7
method: 'GET',
8
9
}
10
11
client.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
});