Get Record Contacts Custom Forms

Returns an array of custom forms associated with the specified checklist item. Each custom form consists of custom field name-and-value pairs.

Resource Information

Scoperecords

Deprecated scope name:   get_record_contact_customforms

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/contacts/{contactId}/customForms?lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
contactIdlongYes Get All Contacts The unique ID associated with the contact.7.3.2
langStringNoIndicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}7.3.2
result.<customType>stringA custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No". 7.3.2
statusintegerThe record status.7.3.3