On this page

Get a user's profile

API Overview

Keeping your user profile up to date helps SendGrid verify who you are and share important communications with you.

You can learn more in the SendGrid Account Details documentation.

Operation overview

GET/v3/user/profile

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

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

This endpoint allows you to retrieve your current profile details.

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.

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

addressstring

The user's address.

address2string

The second line of the user's address.

citystring

The user's city.

companystring

The name of the user's company.

countrystring

The user's country.

first_namestring

The user's first name.

last_namestring

The user's last name.

phonestring

The user's phone number.

statestring

The user's state.

websitestring

The user's website URL.

zipstring

The user's zip code.

Get a user's profile

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