Example filters

Filter based on internal ID of contact:

{"user":{"internal_ref": "internal_id_123456"}}

Filter based on email of contact:

{"user":{"email": "[email protected]"}}

Filter based on flow slug:


Status and default filter

By default, all archived requests are not returned by the API. Returning archived requests should be explicit.

{"archived": true}

You can return all completed requests using:

{"completed": true}

Returning filtered archived requests:

{"user":{"internal_ref": "internal_id_123456"}, "archived": true}

Use the API reference

Click Try It! to start a request and see the response here!