List Sessions
Authentication
AuthorizationBearer
Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.
Query parameters
id
This is the unique identifier for the session to filter by.
name
This is the name of the session to filter by.
assistantId
This is the ID of the assistant to filter sessions by.
assistantIdAny
Filter by multiple assistant IDs. Provide as comma-separated values.
squadId
This is the ID of the squad to filter sessions by.
workflowId
This is the ID of the workflow to filter sessions by.
numberE164CheckEnabled
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)
extension
This is the extension that will be dialed after the call is answered.
assistantOverrides
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.
number
This is the number of the customer.
sipUri
This is the SIP URI of the customer.
name
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>.
email
This is the email of the customer.
externalId
This is the external ID of the customer.
customerNumberAny
Filter by any of the specified customer phone numbers (comma-separated).
phoneNumberId
This will return sessions with the specified phoneNumberId.
phoneNumberIdAny
This will return sessions with any of the specified phoneNumberIds.
page
This is the page number to return. Defaults to 1.
sortOrder
This is the sort order for pagination. Defaults to 'DESC'.
Allowed values:
limit
This is the maximum number of items to return. Defaults to 100.
createdAtGt
This will return items where the createdAt is greater than the specified value.
createdAtLt
This will return items where the createdAt is less than the specified value.
createdAtGe
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLe
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGt
This will return items where the updatedAt is greater than the specified value.
updatedAtLt
This will return items where the updatedAt is less than the specified value.
updatedAtGe
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLe
This will return items where the updatedAt is less than or equal to the specified value.
Response
results
metadata
Pagination and retention metadata returned with a paginated list of phone numbers.