Filter Fields

List filter fields for an entity

get/filterfields/{entity}

Request

Base URL
https://api.salesflare.com
Auth
none declared
TypeScript
https://skmtc.dev/salesflare/apis/salesflare-api/docs/filterfields/:entity/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

entitystring required

Query parameters

pipelinenumber

includePipelineSpecificPredefinedFilterFieldsboolean

Response

Successful

idstring required

query_builder_idstring

customfield_idstring required

labelstring required

namestring

typestring required

inputstring

valuesobject

validationobject

operatorsstring[]

fixed_operator'equal' | 'not_equal' | 'in' | 'not_in' | 'less' | 'less_or_equal' | 'greater' | 'greater_or_equal' | 'between' | 'not_between' | 'begins_with' | 'not_begins_with' | 'contains' | 'not_contains' | 'ends_with' | 'not_ends_with' | 'is_empty' | 'is_not_empty' | 'is_null' | 'is_not_null' | 'true' | 'false' | 'past_less' | 'past_exactly' | 'past_more_than' | 'future_less' | 'future_exactly' | 'future_more_than' | 'after' | 'on' | 'before' | 'is' | 'is_not'

group'Account' | 'Contact' | 'Opportunity' | 'Campaign' | 'Tag' | 'Task' | 'Workflow' | 'Lead'

entity'account' | 'person' | 'opportunity' | 'campaign' | 'tag' | 'task' | 'workflow' | 'workflow_record' | 'workflow_step_record' | 'lead'

display_entity'Account' | 'Contact' | 'Opportunity' | 'Campaign' | 'Tag' | 'Task' | 'Workflow' | 'Lead'

search_entity'account' | 'contact' | 'user' | 'tag' | 'pipeline' | 'workflow' | 'lead'

sortableboolean

pipelinenumber

enabledstring required

param_lessboolean

Changes

No operation changes recorded.