Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Get a user's profile



API Overview

api-overview page anchor

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.


GET/v3/user/profile

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

This endpoint allows you to retrieve your current profile details.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

200
SchemaExample
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

get-a-users-profile page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/user/profile`,
_18
method: 'GET',
_18
_18
}
_18
_18
client.request(request)
_18
.then(([response, body]) => {
_18
console.log(response.statusCode);
_18
console.log(response.body);
_18
})
_18
.catch(error => {
_18
console.error(error);
_18
});


Rate this page: