Salesflare Filter Fields API
The Filter Fields API from Salesflare — 1 operation(s) for filter fields.
OpenAPI Specification
openapi: 3.0.0
info:
title: Salesflare Accounts Filter Fields API
version: 1.0.0
description: '# Introduction
## Getting Started
The Salesflare API allows you to access and build your own applications or integrations that interact with Salesflare.
The Salesflare API provides a RESTful interface with JSON-formatted responses to access most Salesflare resources.
## Authentication
The Salesflare API uses bearer token based authentication, which means you need to use the key-value pair "Authorization : Bearer APIKEY" in the header to authenticate.
You can make an API key in ["Settings" > "API keys"](https://app.salesflare.com/#/settings/apikeys).
Click on the large orange "+" button on the bottom right of the screen to create an API key.
## Requests
All requests must be sent using HTTPS with TLS 1.2 or higher. Please make sure your developer tools support this version of TLS as older versions or SSL are not supported for security reasons.
For PUT or POST requests (e.g. create, update), the payload must be provided as JSON in the request body.
## Responses
Responses use HTTP status codes, with the most typical ones being:
| Code | Meaning |
|------------------------|-----------------------|
| Successful Responses |
| 200 | OK |
| Error Responses |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
## Testing
We recommend testing our API with Postman.
### Download specification
Our API is documented following the OpenAPI specification. You can download it [here](https://api.salesflare.com/openapi.json)
### Import in Postman
To import the collection, open Postman and click Import, then select "Import From Link"
Copy & Paste the following link and press the "Import" button:
> https://api.salesflare.com/openapi.json
## Support
For API questions and support, please email support@salesflare.com or click the chat bubble below.'
contact:
email: support@salesflare.com
x-logo:
url: https://lib.salesflare.com/api_docs/sf-logo-inverted.svg
backgroundColor: '#0f1528'
altText: Salesflare logo
servers:
- url: https://api.salesflare.com
tags:
- name: Filter Fields
paths:
/filterfields/{entity}:
get:
summary: List filter fields for an entity
operationId: getFilterfieldsEntity
parameters:
- name: entity
in: path
required: true
schema:
type: string
- name: pipeline
in: query
schema:
type: number
- name: includePipelineSpecificPredefinedFilterFields
in: query
schema:
type: boolean
default: true
tags:
- Filter Fields
responses:
'200':
description: Successful
content:
'*/*':
schema:
type: array
items:
type: object
properties:
id:
type: string
query_builder_id:
type: string
customfield_id:
type: string
label:
type: string
name:
type: string
type:
type: string
input:
type: string
values:
type: object
validation:
type: object
operators:
type: array
items:
type: string
enum:
- 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
fixed_operator:
type: string
enum:
- 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:
type: string
enum:
- Account
- Contact
- Opportunity
- Campaign
- Tag
- Task
- Workflow
- Lead
entity:
type: string
enum:
- account
- person
- opportunity
- campaign
- tag
- task
- workflow
- workflow_record
- workflow_step_record
- lead
display_entity:
type: string
enum:
- Account
- Contact
- Opportunity
- Campaign
- Tag
- Task
- Workflow
- Lead
search_entity:
type: string
enum:
- account
- contact
- user
- tag
- pipeline
- workflow
- lead
options:
type: array
items:
type: object
properties:
id:
type: array
x-constraint:
single: true
items:
type: string
x-alternatives:
- type: string
- type: number
order:
type: number
name:
type: string
required:
- name
sortable:
type: boolean
pipeline:
type: number
enabled:
type: string
param_less:
type: boolean
required:
- id
- customfield_id
- label
- type
- enabled
x-tagGroups:
- name: General
tags:
- Tasks
- Accounts
- Contacts
- Opportunities
- Workflows
- Insights
- name: Interactions
tags:
- Calls
- Meetings
- Internal Notes
- name: User Management
tags:
- Users
- Groups
- name: Configuration
tags:
- Regional Settings
- Pipelines
- Custom Fields
- Email Data Sources
- Tags
- Filter Fields
- Persons