Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
Page tools
On this page
Looking for more inspiration?Visit the

Get Integration by ID

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(link takes you to an external page) 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

operation-overview page anchor

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

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
idstring
required

The ID of the Integration you would like to retrieve.

Responses

responses page anchor
200403404500

Successful operation

SchemaExample
Property nameTypeRequiredDescriptionChild properties
integration_idstring

Optional

The unique ID of an Integration.

Example: 12345
user_idstring

Optional

Your Twilio SendGrid account ID.

Example: 123456
filtersobject

Optional

The configurable filters for SendGrid to destination email event forwarding.

propertiesobject

Optional

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

labelstring

Optional

The nickname for the Integration.

Default: Untitled IntegrationExample: My New Segment Integration!
destinationenum<string>

Optional

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

Possible values:
Segment
Get Integration by IDLink to code sample: Get Integration by ID
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const id = "id";

5


6
const request = {

7
  url: `/v3/marketing/integrations/${id}`,

8
  method: "GET",

9
};

10


11
client

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
  });