Search Contacts
Search for contacts in SendGrid.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
| Result Set | Choose whether the search returns First Matching Record or First 50 Matching Records. |
Dropdown |
TRUE |
Input
| Field | Definition | Type | Required |
|---|---|---|---|
| Contact | |||
| Address Line 1 | First line of the address. |
Text |
FALSE |
| Address Line 2 | Optional second line for the address. |
Text |
FALSE |
| Alternate Emails | Additional emails associated with the contact. |
Text |
FALSE |
| City | City of the contact. |
Text |
FALSE |
| Country | Country of the contact's address. Accepts full name or abbreviation. |
Text |
FALSE |
| Primary email for the contact. |
Text |
FALSE |
|
| First Name | Contact's personal name. |
Text |
FALSE |
| Last Name | Contact's family name. |
Text |
FALSE |
| Postal Code | Postcode, post code, Eircode, PIN code or ZIP code. |
Text |
FALSE |
| State Province Region | State, province, or region of the contacts address. |
Text |
FALSE |
| Search By Custom Filter | |||
| Custom Filter |
A custom search filter that may be used in addition to or separately from the rest of the input fields on this Search Contacts action card. To use a custom filter, you must create an SGQL expression. See Segmentation Query Language Reference. Example 1 Search query with empty input fields in the Contact section and this custom filter: email = 'myemail@mail.com' This search produces contacts with this exact email address. Example 2 Search query with values in one or more input fields in the Contact section and this custom filter: OR email = 'myemail@mail.com' This search produces contacts that either match the values in the input fields or the custom filter. Example 3 "query": "email LIKE '%john%' AND city LIKE '%New%'" This search produces contacts with email address that contain "john" and any city that contains "New". Example 4 "query": "email LIKE '%john%' OR city LIKE '%New%'" This search produces contacts with email address that contain "john" or contacts with any city that contains "New". Example 5 "query": "email = 'john.smith@email.com' OR city = 'New'" This search produces contacts with the email address john.smith@email.com or contacts with any city that contains "New". You must use the custom filter expression email ="<email>" to return data for the following fields:
|
Various |
FALSE |
Output
| Field | Definition | Type |
|---|---|---|
| Contact | ||
| Address Line 1 | First line of the address. |
Text |
| Address Line 2 | Optional second line for the address. |
Text |
| Alternate Emails | Additional emails associated with the contact. |
Text |
| City | City of the contact. |
Text |
| Country | Country of the contact's address. Accepts full name or abbreviation. |
Text |
| Primary email for the contact. |
Text |
|
| ID | Unique identifier of the contact in SendGrid. |
Text |
| First Name | Contact's personal name. |
Text |
| Last Name | Contact's family name. |
Text |
| List IDs | IDs of lists to which the contact is added. |
List of Text |
| Postal Code | Postcode, post code, Eircode, PIN code or ZIP code . |
Text |
| Segment IDs | IDs of segments in which the contact is included. |
List of Text |
| State Province Region | State, province, or region of the contacts address. |
Text |
| Phone Number | Primary phone number for the contact. |
Text |
| Whatsapp account for the contact. |
Text |
|
| Line | Landline for the contact. |
Text |
| Primary Facebook profile for the contact. |
Text |
|
| Unique Name | Unique name assigned to the contact. |
Text |
| Created At | Time this record was created, in unixtime. |
Text |
| Updated At | Last update date for this contact's record. |
Text |
| Custom Fields | Custom fields created for the contact in SendGrid. | Various |