Menu

Contacts API - Custom Fields

Elements that can be shared among more than one endpoint definition.

Retrieve a Custom Field

Retrieve a Custom Field

GET /contactdb/custom_fields/{custom_field_id}

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

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Path Parameters

custom_field_id
integer

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

required

Responses

object
name
string

The name of the field

type
string

The type of the field.

Allowed Values: date, text, number
id
number

The ID of the custom field.

{
  "name": "first_name",
  "type": "text"
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.