List Sessions
Query parameters
This is the unique identifier for the session to filter by.
This is the name of the session to filter by.
This is the ID of the assistant to filter sessions by.
Filter by multiple assistant IDs. Provide as comma-separated values.
This is the ID of the squad to filter sessions by.
This is the ID of the workflow to filter sessions by.
This is the flag to toggle the E164 check for the number field. This is an advanced property which should be used if you know your use case requires it.
Use cases:
- false: To allow non-E164 numbers like +001234567890, 1234, or abc. This is useful for dialing out to non-E164 numbers on your SIP trunks.
- true (default): To allow only E164 numbers like +14155551234. This is standard for PSTN calls.
If false, the number is still required to only contain alphanumeric characters (regex: /^\+?[a-zA-Z0-9]+$/).
@default true (E164 check is enabled)
This is the extension that will be dialed after the call is answered.
These are the overrides for the assistant's settings and template variables specific to this customer. This allows customization of the assistant's behavior for individual customers in batch calls.
These are the overrides applied when the call targets a squadId. Mirrors the call-level squadOverrides — use this instead of assistantOverrides when the campaign or call is squad-based.
This is the number of the customer.
This is the SIP URI of the customer.
This is the name of the customer. This is just for your own reference.
For SIP inbound calls, this is extracted from the From SIP header with format "Display Name" <sip:username@domain>.
This is the email of the customer.
This is the external ID of the customer.
Filter by any of the specified customer phone numbers (comma-separated).
This will return sessions with the specified phoneNumberId.
This will return sessions with any of the specified phoneNumberIds.
This is the page number to return. Defaults to 1.
This is the sort order for pagination. Defaults to 'DESC'.
This is the column to sort by. Defaults to 'createdAt'.
This is the maximum number of items to return. Defaults to 100.
This will return items where the createdAt is greater than the specified value.
This will return items where the createdAt is less than the specified value.
This will return items where the createdAt is greater than or equal to the specified value.
This will return items where the createdAt is less than or equal to the specified value.
This will return items where the updatedAt is greater than the specified value.
This will return items where the updatedAt is less than the specified value.
This will return items where the updatedAt is greater than or equal to the specified value.
This will return items where the updatedAt is less than or equal to the specified value.