Skip to contentSkip to navigationSkip to topbar
On this page

Get a Contact by ID

Operation overview

operation-overview page anchor

GET/v3/marketing/contacts/{id}

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

This endpoint returns the full details and all fields for the specified contact. The "Get Contacts by Identifier" endpoint can be used to get the ID of a contact.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
idstring
required

Responses

responses page anchor
200401403404500
Schema
Property nameTypeRequiredDescriptionChild properties
idstring

Optional

firstNamestring

Optional

lastNamestring

Optional

uniqueNamestring

Optional

emailstring

Optional

phoneNumberIdstring

Optional

externalIdstring

Optional

anonymousIdstring

Optional

alternateEmailsarray[string]

Optional

addressLine1string

Optional

addressLine2string

Optional

citystring

Optional

stateProvinceRegionstring

Optional

countrystring

Optional

postalCodestring

Optional

phoneNumberstring

Optional

whatsappstring

Optional

linestring

Optional

facebookstring

Optional

listIdsarray[string]

Optional

segmentIdsarray[string]

Optional

customFieldsobject

Optional

createdAtstring

Optional

updatedAtstring

Optional

MetadataselfMetadata

Optional

Get a Contact by IDLink to code sample: Get a Contact by ID
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const id = "id";

5


6
const request = {

7
  url: `/v3/marketing/contacts/${id}`,

8
  method: "GET",

9
};

10


11
client

12
  .request(request)

13
  .then(([response, body]) => {

14
    console.log(response.statusCode);

15
    console.log(response.body);

16
  })

17
  .catch((error) => {

18
    console.error(error);

19
  });