Requests

Welcome to SendGrid's Web API v3! This API is RESTful and offers support in seven different languages.

• C#
• Go
• Java
• Node.js
• PHP
• Python
• Ruby

The host for Web API v3 requests is always https://api.sendgrid.com/v3/

All requests must be made over HTTPS. The API does not support HTTP.

You must provide an authorization header as described in Authentication.

The API provides JSON responses. It doesn't currently require the accept header, but might in the future. If not set, the API will use application/json.

1
GET https://api.sendgrid.com/v3/endpoint HTTP/1.1
2
Accept: application/json

When you send an array of data in a GET request, you will include the parameter multiple times on the URL. The parameter name does not require brackets.

When submitting data to a resource via POST or PUT, you must submit your payload in JSON.

1
POST https://api.sendgrid.com/v3/templates/ HTTP/1.1
2
Content-Type: application/json

1
{
2
  "name": "new template name"
3
}

Some GET resources allow for retrieval of information in batches. We will provide the query args in the resource documentation when available to consume.

When requesting multiple items, we will default the request limit to 500 items. You can specify a different limit but cannot exceed the default limit.

Resources documented will display a bolded list of available paginated parameters if available.

Below is a basic pagination example. In the resource documentation, we will only provide the bolded list of available parameters.

A Link Header is provided in the response for batched information.

GET https://api.sendgrid.com/v3/resource?limit=300&offset=10 HTTP/1.1

Some resources allow for you to search by a specific field. Other resources require you to append a parameter to the URI.

In this example, we will display a paginated URI example, searching for resources where the email contains foo.

GET https://api.sendgrid.com/v3/resource?email=foo&bar=baz HTTP/1.1

Below is a general overview of what resource objects return with successful Web API requests.