Contact

Get custom contact fields

Gets a list of all custom fields defined for contacts in this project. The return value is an array of objects with the properties 'name', 'variable', 'type', 'order', 'readonly', 'lookup_key', and 'show_on_conversation'. (Fields are automatically created any time a Contact's 'vars' property is updated.)

get/v1/projects/{project_id}/contact_fields

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/contact_fields
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Response

Successful response

namestring

Display name of the field

variablestring

Variable name used in the API

typestring

Field type

orderinteger

Display order of the field

readonlyboolean

Whether the field is read-only

lookup_keyboolean

Whether the field is a lookup key

show_on_conversationboolean

Whether to show field on Conversations tab

Changes

No recorded changes to this operation across all 1 revision of this API.