List Sessions

Retrieves a list of sessions from Vapi.

POST

Body

Arguments

string

This is the unique identifier for the session to filter by.

string

This is the name of the session to filter by.

string

This is the ID of the assistant to filter sessions by.

string

Filter by multiple assistant IDs. Provide as comma-separated values.

string

This is the ID of the squad to filter sessions by.

string

This is the ID of the workflow to filter sessions by.

boolean

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)

string

This is the extension that will be dialed after the call is answered.

string

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.

string

This is the number of the customer.

string

This is the SIP URI of the customer.

string

This is the email of the customer.

string

This is the external ID of the customer.

string

Filter by any of the specified customer phone numbers (comma-separated).

string

This will return sessions with the specified phoneNumberId.

array of string

This will return sessions with any of the specified phoneNumberIds.

number

This is the page number to return. Defaults to 1.

string

This is the sort order for pagination. Defaults to 'DESC'.

number

This is the maximum number of items to return. Defaults to 100.

string

This will return items where the createdAt is greater than the specified value.

string

This will return items where the createdAt is less than the specified value.

string

This will return items where the createdAt is greater than or equal to the specified value.

string

This will return items where the createdAt is less than or equal to the specified value.

string

This will return items where the updatedAt is greater than the specified value.

string

This will return items where the updatedAt is less than the specified value.

string

This will return items where the updatedAt is greater than or equal to the specified value.

string

This will return items where the updatedAt is less than or equal to the specified value.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Every app you connect,one REST pattern