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. | String | FALSE |
Address Line 2 | Optional second line for the address. | String | FALSE |
Alternate Emails | Additional emails associated with the contact. | String | FALSE |
City | City of the contact. | String | FALSE |
Country | Country of the contact's address. Accepts full name or abbreviation. | String | FALSE |
Primary email for the contact. | String | FALSE | |
First Name | Contact's personal name. | String | FALSE |
Last Name | Contact's family name. | String | FALSE |
Postal Code | Postcode, post code, Eircode, PIN code or ZIP code. | String | FALSE |
State Province Region | State, province, or region of the contacts address. | String | 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: 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: This search produces contacts that either match the values in the input fields or the custom filter. Example 3
This search produces contacts with email address that contain "john" and any city that contains "New". Example 4
This search produces contacts with email address that contain "john" or contacts with any city that contains "New". Example 5
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
|
Various | FALSE |
Output
Field | Definition | Type |
---|---|---|
Contact | ||
Address Line 1 | First line of the address. | String |
Address Line 2 | Optional second line for the address. | String |
Alternate Emails | Additional emails associated with the contact. | String |
City | City of the contact. | String |
Country | Country of the contact's address. Accepts full name or abbreviation. | String |
Primary email for the contact. | String | |
ID | Unique identifier of the contact in SendGrid. | String |
First Name | Contact's personal name. | String |
Last Name | Contact's family name. | String |
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 . | String |
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. | String |
Phone Number | Primary phone number for the contact. | String |
Whatsapp account for the contact. | String | |
Line | Landline for the contact. | String |
Primary Facebook profile for the contact. | String | |
Unique Name | Unique name assigned to the contact. | String |
Created At | Time this record was created, in unixtime. | String |
Updated At | Last update date for this contact's record. | String |
Custom Fields | Custom fields created for the contact in SendGrid. | Various |