Leads

Get the lead custom fields

get/leads/customfields

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/leads/customfields
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token

Response

OK

tenantIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
entityType'LEAD' | 'WORKFLOW' | 'EMPLOYER' | 'CUSTOMER' | 'CONTACT' | 'MEETING'
gridColIdstring
gridFieldstring
fieldNamestring
clearFieldNamestring
labelstring
exportLabelstring
descriptionstring
clearableboolean
readOnlyboolean
type'BOOLEAN' | 'DATE' | 'DATETIME' | 'MONETARY' | 'PERCENT' | 'TEXT' | 'TEXT_MULTILINE' | 'NUMERIC' | 'DROPDOWN' | 'PRODUCT_TYPE' | 'COMPANY' | 'PRODUCT' | 'MAAMAD' | 'EMPLOYER' | 'PAYMENT_METHOD' | 'PENSION_INSURANCE_TRACK' | 'INVESTMENT_TRACK' | 'AGENT_NUMBER' | 'COUNTRY' | 'USER' | 'CONTACT' | 'CELL_NUMBER' | 'EMAIL' | 'PHONE_NUMBER' | 'ISRAELI_ID_NUMBER' | 'ISRAELI_CITY' | 'CUSTOMER_SOURCE' | 'YEAR_MONTH' | 'TIME' | 'LICENSEE' | 'MEETING_REMINDER_STATUS' | 'AGENCY' | 'LEAD'
groupstring
groupPositioninteger
fieldPositioninteger
extraPropsstring
colDefParamsobject
gridColTypestring
exportPropertyPathstring
exportPropertyTypestring
gridVisibleboolean
gridPositioninteger
gridInitialHideboolean
gridSortableboolean
gridFilterableboolean
gridExportableboolean
gridInitialWidthinteger
gridEditableboolean
gridAutosizeboolean
cardFieldsDisplayedboolean
viewAuthorizedUsersstring[]
updateAuthorizedUsersstring[]
customFieldsReadIncludeRolesstring[]
customFieldsReadExcludeRolesstring[]
customFieldsWriteIncludeRolesstring[]
customFieldsWriteExcludeRolesstring[]
includedInTemplateboolean
gridColPrimaryTypestring
systemFieldboolean

Changes

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