On this page

Get Integration by ID

API Overview

An Integration is a connection from a SendGrid Marketing Campaign to a supported third-party application. Integrations with different external applications allow you to sync data and create a more cohesive cross-product data experience.

Currently, only Segment Integrations are supported. Segment Integrations allow you to customize and automate email event forwarding to your Segment account.

The Integrations API allows you to create, retrieve, update, and delete your Integrations.

Operation overview

GET/v3/marketing/integrations/{id}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint returns the data for a specific Integration.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

idstringrequired

The ID of the Integration you would like to retrieve.

Responses

200403404500

Successful operation

SchemaExample

Property nameTypeRequiredDescriptionChild properties

integration_idstring

The unique ID of an Integration.

user_idstring

Your Twilio SendGrid account ID.

filtersobject

The configurable filters for SendGrid to destination email event forwarding.

Show child properties for filters

propertiesobject

The properties of an Integration required to send events to a specific third-party application.

Show child properties for properties

labelstring

The nickname for the Integration.

Default: Untitled Integration

destinationenum<string>

The third-party application you would like to forward your events to.

Possible values:

Segment

Get Integration by ID

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const id = "id";
5
6const request = {
7  url: `/v3/marketing/integrations/${id}`,
8  method: "GET",
9};
10
11client
12  .request(request)
13  .then(([response, body]) => {
14    console.log(response.statusCode);
15    console.log(response.body);
16  })
17  .catch((error) => {
18    console.error(error);
19  });