SendGrid

Retrieves a single custom field definition by its ID from SendGrid Marketing Campaigns. Custom fields store additional information about your contacts beyond the reserved fields (email, first_name, last_name, etc.). This endpoint returns the field's ID, name, and data type. **Response includes:** - `id`: Unique string…

Untrusted display-only summary

Retrieves your current address whitelist mail settings from SendGrid. The Address Whitelist setting allows you to specify email addresses or domains for which mail should never be suppressed. For example, if you whitelist 'example.com', all bounces, blocks, and unsubscribes logged for that domain will be ignored and m…

Untrusted display-only summary

Checks if an email address is in the global suppression list. Globally suppressed emails will not receive any emails from your SendGrid account. Returns the email address if found in the global suppression list, or an empty response if not suppressed. This is useful for verifying if a recipient has opted out globally…

Untrusted display-only summary

This endpoint provides a list of authorized IP addresses for your account, each with creation, update dates, and a unique ID for potential removal.

Untrusted display-only summary

Retrieve all SendGrid alerts configured for your account. Returns a list of alert configurations including: - **usage_limit alerts**: Notify when email usage reaches a specified percentage threshold (0-100%). - **stats_notification alerts**: Send periodic email statistics at daily, weekly, or monthly intervals. Each a…

Untrusted display-only summary

Retrieves all IP addresses that are currently assigned to your account. This endpoint returns a list of IP addresses that have been assigned to your account for sending emails. Each IP address includes information about: - The IP address itself - The IP pools it belongs to - Whether it's currently in warmup mode - The…

Untrusted display-only summary

Retrieves a paginated list of all blocked email addresses from your SendGrid account. Blocks occur when a recipient's email server rejects a message for reasons related to the message itself (not the recipient address), such as: - Your sending IP being blocked by an ISP - Message content flagged by spam filters - Serv…

Untrusted display-only summary

This endpoint retrieves a paginated list of all your bounces, allowing customization of page size with `limit` and starting position with `offset` for multiple requests.

Untrusted display-only summary

**This endpoint allows you to retrieve all branded links**. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

Untrusted display-only summary

Retrieve a paginated list of campaigns in reverse creation order with the API endpoint. If none exist, get an empty array. Adjust page size with `limit`, and fetch more with `offset`.

Untrusted display-only summary

Retrieve all email categories used for tracking and organizing email statistics. Categories are user-defined labels that can be assigned to emails when sending. They help organize email statistics and enable filtering/grouping of metrics by category. This is useful for tracking different email campaigns, types of comm…

Untrusted display-only summary

Retrieve all custom field definitions for contacts. Returns a list of all custom fields that have been created for your contacts. Custom fields allow you to store additional information about your contacts beyond the default fields (first_name, last_name, email, etc.). Each custom field includes: - id: Unique integer…

Untrusted display-only summary

Retrieves a paginated list of all email addresses that are globally suppressed from receiving any emails from your SendGrid account. Global suppressions are recipients who have unsubscribed from all your emails, not just specific groups. Each suppression includes the email address and when it was added. Use `limit` an…

Untrusted display-only summary

Retrieve paginated lists of invalid emails with 'limit' for page size and 'offset' to start from a specific position for lists exceeding the limit.

Untrusted display-only summary

Retrieve a paginated list of assigned/unassigned IPs with warmup status, pools, subusers, and DNS info. IP reputation is based on email traffic. Use `limit` and `offset` parameters to control pagination.

Untrusted display-only summary

**This endpoint allows you to get all of your IP pools.**

Untrusted display-only summary

Retrieves details for a specific IP address including all IP pools it belongs to, subusers that can use it, warmup status, and reverse DNS record. The same IP address can belong to multiple IP pools. Requires the 'ips.read' API scope and a dedicated IP address on your SendGrid account.

Untrusted display-only summary

Retrieve all IP addresses currently in the warmup process. IP warmup is the process of gradually increasing sending volume through a new IP address to build a positive sending reputation. This endpoint returns all IPs that are actively being warmed up. The response includes: - ip: The IP address being warmed up - star…

Untrusted display-only summary

Retrieve all contact lists from your SendGrid account. Lists are static collections of Marketing Campaigns contacts. Returns an array of all lists with their IDs, names, and contact counts. If no lists exist, returns an empty array.

Untrusted display-only summary

Retrieve a paginated list of mail settings with their `enabled` status and descriptions. Control page size with `limit` and list position with `offset` for multiple requests.

Untrusted display-only summary

The endpoint fetches all Event Webhooks as objects in an array, showing each webhook's configuration and ID, used to update, delete, or manage signature verification and OAuth settings.

Untrusted display-only summary

**This endpoint allows you to retrieve all of your current inbound parse settings.**

Untrusted display-only summary

**This endpoint allows you to retrieve a list of all pending Teammate invitations.** Each teammate invitation is valid for 7 days. Users may resend the invitation to refresh the expiration date.

Untrusted display-only summary

Retrieves a list of all IP addresses that have recently attempted to access your SendGrid account, either through the User Interface or the API. This endpoint is part of SendGrid's IP Access Management feature, which helps monitor and secure account access. Each access attempt record includes the IP address, authentic…

Untrusted display-only summary

Retrieves all recipients (contacts) belonging to a specific list in SendGrid's Legacy Marketing Campaigns. **IMPORTANT**: This endpoint is part of SendGrid's legacy Contacts API (`/v3/contactdb/`). Some SendGrid accounts may not have access to this legacy API. For newer accounts, consider using the newer Marketing Cam…

Untrusted display-only summary

The endpoint provides a paginated list of Reverse DNS records, with optional IP prefix search and adjustable page size using 'limit' and 'offset' parameters.

Untrusted display-only summary

The endpoint provides details of cancelled or paused scheduled sends but only if they have a `batch_id`. Sends scheduled without a `batch_id` via `/mail/send` won't be listed and can't be paused or cancelled later through this endpoint.

Untrusted display-only summary

Retrieve spam reports in pages using `limit` for page size and `offset` to continue from a specific list position. Multiple requests handle larger lists.

Untrusted display-only summary

Retrieve a list of all suppressions across all suppression groups. Suppressions are recipient email addresses that have been added to unsubscribe groups. Once a recipient's address is on the suppressions list for an unsubscribe group, they will not receive any emails that are tagged with that unsubscribe group. This e…

Untrusted display-only summary

**This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**

Untrusted display-only summary