Use this endpoint to retrieve up to 100 contacts that match the requested identifier values for a single identifier type.
identifier_type must be a valid identifier type: email, phone_number_id, external_id, or anonymous_id.
Use this endpoint instead of the Search Contacts endpoint when you can provide exact identifiers and do not need to include other Segmentation Query Language (SGQL) filters when searching.
This endpoint returns a 200 status code when any contacts match the identifiers you supplied. When searching multiple identifier values in a single request, it is possible that some will match a contact while others will not. When a partially successful search like this is made, the matching contacts are returned in an object and an error message is returned for the identifier values that are not found.
This endpoint returns a 404 status code when no contacts are found for the provided identifiers.
This endpoint returns a 400 status code if any searched addresses are invalid.
Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.
Bearer <<YOUR_API_KEY_HERE>>The type of identifier to search for. You can use only one type of identifier per search.
emailphone_number_idexternal_idanonymous_idapplication/jsonOne or more more identifier values of the given identifier type to search for in your Marketing Campaigns contacts.
An object containing the contacts that match the searched identifier values.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const identifier_type = "email";5const data = {6identifiers: ["contact@example.com"],7};89const request = {10url: `/v3/marketing/contacts/search/identifiers/${identifier_type}`,11method: "POST",12body: data,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});