Retrieve a list of custom fields (get)
The get
Ortto endpoint of the custom-field
entity is used to retrieve a list of the custom contact (person) or organization fields in Ortto’s customer data platform (CDP).
This page provides descriptions of this endpoint’s:
-
valid parameters, headers, and request body values, as well as
-
the response payload.
HTTP method and request resources
POST https://api.ap3api.com/v1/person/custom-field/get
POST https://api.ap3api.com/v1/organizations/custom-field/get
Headers
This endpoint requires a custom API key and content type (application/json
for the request body) in the header of the request:
-
X-Api-Key: CUSTOM-PRIVATE-API-KEY
-
Content-Type: application/json
Response payload
The response payload consists of a JSON object with the elements listed in the table below.
The following JSON object is an example of the custom field data that Ortto retrieves from your Ortto account’s CDP after a request to this endpoint.
{
"fields": [
{
"field": {
"id": "str:cm:customfieldtextperson",
"name": "$customfieldtextPerson",
"display_type": "text",
"liquid_name": "people.custom.customfieldtextperson"
},
"tracked_value": false
}
]
}
{
"fields": [
{
"id": "bol:oc:custom-org-field-boolean",
"name": "Custom Org field boolean",
"display_type": "bool",
"liquid_name": "organization.custom.custom-org-field-boolean"
},
{
"id": "sst:oc:orgmultiselectfield",
"name": "orgMultiSelectField",
"display_type": "multi_select",
"liquid_name": "organization.custom.orgmultiselectfield"
}
]
}
Response payload elements
The following table lists all elements (arrays, objects, or fields) in the response from a request to this endpoint.
Element | Type | Description | ||
---|---|---|---|---|
|
|
The * Person is an array of objects containing * Organization is an array of field objects. |
||
|
|
Identifies a custom person (contact) field object. |
||
|
|
The identifier for the field name in Ortto’s custom field ID format. |
||
|
|
The name specified for the field when it was created. |
||
|
|
The name of the field |
||
|
|
The Liquid language tag for the field. |
||
|
|
If |