Fetch a custom field

GET 
/v2/custom_fields/:id

Fetches a custom field, by ID only.

Request

Path Parameters

id stringrequired

Custom Field ID

Responses

200

Success

application/json

Schema

Schema

id integer

ID of Custom Field

name string

Name of the Custom Field

field_type string

Type of the Custom Field. Value must be one of: person, company, opportunity.

value_type string

Value Type of the Custom Field. Value must be one of: text, date.

created_at date-time

Datetime of when the Custom Field was created

updated_at date-time

Datetime of when the Custom Field was last updated

Example (from schema)

{
  "id": 1,
  "name": "My Custom Field",
  "field_type": "person",
  "value_type": "text",
  "created_at": "2024-01-01T00:00:00.000000+00:00",
  "updated_at": "2024-01-01T00:00:00.000000+00:00"
}

Loading...