Skip to content Skip to navigation Skip to topbar

Get a specific Sender

API Overview

Operation overview

GET/v3/marketing/senders/{id}

Base url: https://api.sendgrid.com

This endpoint allows you to get the details for a specific Sender by id.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Path parameters

Property nameTypeRequiredDescription

idintegerrequired

The unique identifier of the Sender.

Responses

200404

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idinteger

The unique identifier of the Sender.

nicknamestring

A nickname for the Sender. Not used for sending.

fromobject

Show child properties for from

reply_toobject

Show child properties for reply_to

addressstring

The physical address of the Sender.

address_2string

Additional Sender address information.

citystring

The city of the Sender.

statestring

The state of the Sender.

zipstring

The zipcode of the Sender.

countrystring

The country of the Sender.

verifiedboolean

A boolean flag indicating whether the Sender is verified or not. Only verified Senders can be used to send email.

lockedboolean

A boolean flag that is true when the Sender is associated with a campaign in Draft, Scheduled, or In Progress status. You cannot update or delete a locked Sender.

updated_atinteger

The time the Sender was last updated.

created_atinteger

The time the Sender was created.

Get a specific Sender by ID

Node.js

Python

Java

PHP

Ruby

curl


_19const client = require('@sendgrid/client');
_19client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19const id = 1;
_19
_19const request = {
_19  url: `/v3/marketing/senders/${id}`,
_19  method: 'GET',
_19  
_19}
_19
_19client.request(request)
_19  .then(([response, body]) => {
_19    console.log(response.statusCode);
_19    console.log(response.body);
_19  })
_19  .catch(error => {
_19    console.error(error);
_19  });