V2 API functionality gaps: ContactGroupAssign DateCreated, custom field search, task custom fields

API Q&A
1

Good Afternoon,

We’ve been working through our updates to the API and have noted a few gaps, in terms of functionality within the v2 API. Having said that, it is encouraging to see some gaps on my list get implemented as time goes on (e.g. Complete Goal) hence I am hopeful that most use cases will be fulfilled well in advance of the sunset date.

There are some business critical gaps which we have which are yet to be addressed, hence I felt the need to put these forward to understand whether these are on the roadmap to be addressed or to determine what the alternative solution would be.

  1. Retrieve Tags by DateCreated - we use tags for reporting (e.g. time between tags) and as such it is critically important to be able to retrieve the dates when a tag was applied.

    Currently this can be efficiently performed via XMLRPC by retrieving tags with a DateCreated after a point in time to get a delta of newly tagged contacts.

    Unfortunately the v2 API does not appear to provide the date that a tag was applied to the contact either via the GET /contacts endpoint or GET /tags/{tag_id}/contacts

    In addition to this, both of these endpoints would require knowledge of the contactid or tagid to be able to retrieve the information, potentially resulting in 100s of API calls to determine which tags have been applied to which contacts since a certain point in time.

    Hence is there any functionality in the /v2 API which can facilitate this, if not, is this currently on the roadmap?

  2. Retrieve Contact by Custom Fields - one of our legacy systems currently uses one of our Keap instances to manage subscriptions via tags, with payment notifications for subscriptions coming via webhooks from payment providers (which have their own identifier for the contact which is currently stored in a custom field).

    Hence in order to apply a tag, we currently are looking up the contact via the custom field to apply the tag.

    Is there currently or is there going to be the ability to search contacts by custom field in the v2 API?

  3. Custom Fields on Tasks - We currently use custom fields for storing metadata on tasks, a lot of which is written to the task via an API. The API docs however state that POST and PUT actions do not support custom fields, are there plans to support this as part of the v2 API and if so when is this likely to be available?

Regards,
James Austin

2

Hi @James_Austin,

Good morning and thank you for the detailed context.

  1. Retrieve Tags by DateCreated
    In v2, we currently have two endpoints that may help with this use case, GET /contacts/{contact_id}/tags and GET /tags/{tag_id}/contacts.

    Using these endpoints, you can retrieve the contact tag relationships needed for your use case.

    At this time, the v2 API does not provide a direct way to retrieve tag applications filtered by the date they were applied without specifying either a contact ID or a tag ID. I’ll share this use case with the team so we can evaluate this scenario.

  2. Wildcard filtering is not available in v2. Due to performance considerations, this capability was not included in the current version of the API.

  3. This is one of the gaps we’ve identified and it is being tracked in our Known Issues tracker. I’ll be sure to let you know as soon as we have updates to share regarding support for custom fields on tasks in v2.

Thanks,
Omar

3

@James_Austin - Regarding Point 2 see my reply as someone else recently asked for this.

https://integration.keap.com/t/looking-up-people-via-custom-field/93930/2