[DONE] API Documentation Missing Filters for relation and user fields

🔧 Bugs & Issues
1

The API documentation found here on filters: Filter | Tape Developers is missing information about how to filter by a relationship field and by a member field. Are these filters possible?

What are the types and match types for these fields? And do all conditions work? Does the values still need to be an array?

I’ve tried every combination of type and match type I can think of but I can’t figure it out.

1 Like
2

Even though they are not documented in the Developer API, here is the missing information for anyone else who might need this.

type: app, field_type options: single_relation, multi_relation
type: contact, field_type options: single_user, multi_user
type: calculation, field_type options: calculation

This is relevant to anyone using the filter items API endpoint or using getManyFiltered in the Tape SDK.

4 Likes
3

I just wanted to share this as well, this is a raw dump of the entire Tape SDK that’s used by the Execute Script function. There is SO MUCH good information in here and I’m trying to break it up to teach an AI model to better write workflows in pure Javascript. Hopefully it might be useful to others as well!

https://syncrony.nyc3.cdn.digitaloceanspaces.com/tape-sdk.types.ts

HUGE shoutout to @jacquelynmay for providing this raw info!

5 Likes
4

Hi Andrew,

thanks for bringing this up - the team has updated the docs to include the missing ones (relation, user and calculation):

Hopefully this can be helpful for the future - thanks again for your patience and resilience with “engineering” and sharing the expected inputs to the community - we really appreciate your effort here! :pray:

Cheers
Tim

1 Like
5

@Tim Thanks so much for this update! I just discovered that Multi Date fields (where field_type = range_date) is not referenced either and this should be an easy add.

I just realized also that the following are missing and are a bit complex as I’m not completely sure how they would work:

checklist - Would this let you filter based on the filters available in the UI? I’d be curious to see what the filter JSON needs to look like.
single_attachment, multi_attachment, multi_link, multi_image - Because the UI shows these as text based filters, is it searching the name of the file? The link URL?

I guess single_link and single_image don’t exist as these fields can only be configured to accept multiple values.

Huge thanks to you and your team for all your amazing work! :slight_smile:

2 Likes