On this page

Search Contacts

Operation overview

POST/v3/marketing/contacts/search

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

Use this endpoint to locate contacts.

The request body's query field accepts valid SGQL for searching for a contact.

Because contact emails are stored in lower case, using SGQL to search by email address requires the provided email address to be in lower case. The SGQL lower() function can be used for this.

Only the first 50 contacts that meet the search criteria will be returned.

If the query takes longer than 20 seconds, a 408 Request Timeout status will be returned.

Formatting the created_at and updated_at values as Unix timestamps is deprecated. Instead, they are returned as ISO format as string.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Request body

Encoding type:application/json

SchemaExample

Property nameTypeRequiredDescriptionChild properties

querystringrequired

An SGQL search string or other pattern.

Responses

200400401403404408500

Schema

Property nameTypeRequiredDescriptionChild properties

resultarray[object]

Show child properties for result

_metadataobject

Show child properties for _metadata

contact_countnumber

The total number of contacts matched.

Search Contacts

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  query:
6    "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')",
7};
8
9const request = {
10  url: `/v3/marketing/contacts/search`,
11  method: "POST",
12  body: data,
13};
14
15client
16  .request(request)
17  .then(([response, body]) => {
18    console.log(response.statusCode);
19    console.log(response.body);
20  })
21  .catch((error) => {
22    console.error(error);
23  });