I am wanting to get a list of calendar events from the API that were created by the Nylas scheduler specifically. Is there a quick way to filter or check for events created by Nylas? I was planning on setting a metadata field to determine this but I was wondering if there was a better way than that.
Great question! Our scheduler supports this out of the box.
Any event created with the scheduler will have the filterable metadata key5 set to the ID of the scheduling configuration used to create it, and source: scheduler set. You can filter on GET /events using metadata_pair=key5:<config_id> to find just the events created by a specific scheduling page.
If you have more than one active scheduler config, you’ll need to make separate queries to fetch the events for each one.
I’ve attached a screenshot of an example event with this metadata in the response in case that’s helpful.