ActiveCampaign Forum

Contact Api V3 search by query params 'fields'


#1

Hello can you help me to filter Contacts using the params ‘fields’ at

https://developers.activecampaign.com/reference#list-all-contacts

What I tried that did not work are:

https://account.api-us1.com/api/3/contacts?filters[fields][%phone%]=01234567890

https://account.api-us1.com/api/3/contacts?filters[fields][phone]=01234567890

https://account.api-us1.com/api/3/contacts?filters[phone]=01234567890

https://account.api-us1.com/api/3/contacts?fields[phone]=01234567890

Thank you


#2

its always returning the record even the phone number does not exist.

I want to use the query params ‘fields’ because I want to extend the filter with custom field.


#3

I’ve followed this up with Support via email and apparently the correct API call is:

https://[accountname].api-us1.com//api/3/contacts?filters[custom-field-name]=01234567890

However there is a bug with the endpoint and it does not work. This bug has been acknowledged by Support and passed to their Developers.


#4

I can confirm … this filter is ignored


#5

Do we have an ETA on this being fixed?

I need this for an application.

Alternatively, is there another way to return specific contacts based on a search?


#6

If I use the email field, the filter works if I have the full email. The “contains” functionality doesn’t work.

Also if I try and use any other field, nothing is returned. I’ve tried firstName, lastName, & orgid

If I mispell the field name, all contacts are returned.


#7

I’ve contacted support and got confirmation that contacts filtering doesn’t currently work with API v3. I was suggested to use API v1 for now as a workaround, with filters[fields][%PERSTAG%]=Value


Custom field with api