API Version 1.2

API Documentation for developers

Getting list of custom filters

URL: /api/filters.format

Method: GET

Overview:

Resource which contains all custom filters defined by user.

Input parameters:
Name Type Description
This method doesn't require any inputs parameters.
Output data: Full list of custom filters. Every list item has following format:
Name Type Description
id string Filter ID
name string Filter name
contacts array[string] Array of contact statuses, which should be shown
tags array[string] Tag names
deals array[string] Only contacts which have deals with given statuses will be shown
address hash Information which address field will be filtered. Contains from two elements: type which describes field type and value which contains filtered field value. type can be one of the following:
  • country_code (ISO country code),
  • city_state (city or state/region) or
  • zip_code (ZIP/postal code).
Sample JSON server response for getting list of contact notes

Next "Getting single filter details"