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
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.
This endpoint allows you to retrieve a custom field by ID.
Bearer <<YOUR_API_KEY_HERE>>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.
The ID of the custom field that you want to retrieve.
The name of the field
The type of the field.
datetextnumberThe ID of the custom field.
1const client = require('@sendgrid/client');2client.setApiKey(process.env.SENDGRID_API_KEY);34const custom_field_id = 4900;56const request = {7url: `/v3/contactdb/custom_fields/${custom_field_id}`,8method: 'GET',910}1112client.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch(error => {18console.error(error);19});