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

Retrieve a Custom Field



API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on the Custom Fields API, please visit the new Marketing Campaigns Custom Fields API.

The Custom Fields API lets you create and manage custom fields for your contacts. Custom fields are used to store additional information about your contacts. For example, you might use custom fields to store a contact's birthday, their favorite color, or any other information that is relevant to your business.


GET/v3/contactdb/custom_fields/{custom_field_id}

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

This endpoint allows you to retrieve a custom field by ID.


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.

custom_field_idintegerrequired

The ID of the custom field that you want to retrieve.

200400401404
SchemaExample
namestring

The name of the field


typeenum<string>

The type of the field.

Possible values:
datetextnumber

idnumber

The ID of the custom field.

Retrieve a Custom Field

retrieve-a-custom-field page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_19
const client = require('@sendgrid/client');
_19
client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19
const custom_field_id = 4900;
_19
_19
const request = {
_19
url: `/v3/contactdb/custom_fields/${custom_field_id}`,
_19
method: 'GET',
_19
_19
}
_19
_19
client.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
});


Rate this page: