Lists sequence runs based on filters.
Common filters are limit and offset. If limit and offset are not provided it will default to 50 and 0 respectively.
Receives filters as query string parameters.
The additional filter options are:
-
phone
- will return sequence runs where the contact's phone number match the phone provided. Note that we prove the numbers with no spaces. -
status
- will return sequence runs where the status of the sequence run matches the status provided. -
channel_id
- will return sequence runs where the channel ID of the step contact belonging to the sequence run matches the channel ID provided. -
before
- will return sequence runs that have a start time before or equal to the provided date. The date provided must be in a ISO8601 format. -
after
- will return sequence runs that have a start time after or equal to the provided date. The date provided must be in a ISO8601 format.
The filters can be grouped, which allows users to get, for instance, all sequence runs
that match a specific number, before or after some date.