List Chats
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 chat to filter by.
assistantId
This is the unique identifier for the assistant that will be used for the chat.
assistantIdAny
Filter by multiple assistant IDs. Provide as comma-separated values.
squadId
This is the unique identifier for the squad that will be used for the chat.
sessionId
This is the unique identifier for the session that will be used for the chat.
previousChatId
This is the unique identifier for the previous chat to filter by.
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.