Skip to content Skip to navigation Skip to topbar

Retrieve all custom fields

API Overview

(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.

Operation overview

GET/v3/contactdb/custom_fields

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

This endpoint allows you to retrieve all custom fields.

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

200401

SchemaExample

Property nameTypeRequiredDescriptionChild properties

custom_fieldsarray[object]

Show child properties for custom_fields

Retrieve all custom fields

Node.js

Python

Java

PHP

Ruby

curl


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