Contacts
Filter contacts
This section describes the filters and fields that can be used to filter search results for this endpoint. The example given is the most simple way to pass a filter into the call. For a more in-depth explanation of boolean filtering, consult the section near the top of this page dealing with filtering.
The following are all the Contact fields that can currently be filtered on, and which filters can be used on each:
`id` - greater_than, less_than, between, exactly, is_empty
`first_name` - contains, exactly, is_empty
`last_name` - contains, exactly, is_empty
`title` - contains, exactly, is_empty
`reports_to_id` - greater_than, less_than, between, exactly, is_empty
`emails.primary` - contains, exactly, is_empty
`emails.secondary` - contains, exactly, is_empty
`address.street` - contains, exactly, is_empty
`address.city` - contains, exactly, is_empty
`address.state` - contains, exactly, is_empty
`address.postal_code` - geo_distance, contains, exactly, is_empty
`country_code` - contains, exactly, is_empty
`phones.other` - contains, exactly, is_empty
`phones.cell` - contains, exactly, is_empty
`phones.work` - contains, exactly, is_empty
`notes` - contains, exactly, is_empty
`is_hot` - exactly, is_empty
`status_id` - greater_than, less_than, between, exactly, is_empty
`entered_by_id` - greater_than, less_than, between, exactly, is_empty
`date_created` - greater_than, less_than, between, is_empty
`date_modified` - greater_than, less_than, between, is_empty
post/contacts/search
Request
- Base URLhttps://api.catsone.com
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
querystring required
The optional string to search within contacts for.
pagenumber required
The current page number of contacts to return.
per_pagenumber required
The number of contacts to return per page.
Request body
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.