Properties
| Name | Type | Description |
|---|---|---|
| id | string | This is the unique identifier for the session to filter by. |
| name | string | This is the name of the session to filter by. |
| assistantId | string | This is the ID of the assistant to filter sessions by. |
| assistantIdAny | string | Filter by multiple assistant IDs. Provide as comma-separated values. |
| squadId | string | This is the ID of the squad to filter sessions by. |
| workflowId | string | This is the ID of the workflow to filter sessions by. |
| customer | object | This is the customer information to filter by. |
| customerNumberAny | string | Filter by any of the specified customer phone numbers (comma-separated). |
| phoneNumberId | string | This will return sessions with the specified phoneNumberId. |
| phoneNumberIdAny | array | This will return sessions with any of the specified phoneNumberIds. |
| page | number | This is the page number to return. Defaults to 1. |
| sortOrder | string | This is the sort order for pagination. Defaults to 'DESC'. |
| sortBy | string | This is the column to sort by. Defaults to 'createdAt'. |
| limit | number | This is the maximum number of items to return. Defaults to 100. |
| createdAtGt | string | This will return items where the createdAt is greater than the specified value. |
| createdAtLt | string | This will return items where the createdAt is less than the specified value. |
| createdAtGe | string | This will return items where the createdAt is greater than or equal to the specified value. |
| createdAtLe | string | This will return items where the createdAt is less than or equal to the specified value. |
| updatedAtGt | string | This will return items where the updatedAt is greater than the specified value. |
| updatedAtLt | string | This will return items where the updatedAt is less than the specified value. |
| updatedAtGe | string | This will return items where the updatedAt is greater than or equal to the specified value. |
| updatedAtLe | string | This will return items where the updatedAt is less than or equal to the specified value. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetSessionPaginatedDTO",
"title": "GetSessionPaginatedDTO",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "This is the unique identifier for the session to filter by."
},
"name": {
"type": "string",
"description": "This is the name of the session to filter by."
},
"assistantId": {
"type": "string",
"description": "This is the ID of the assistant to filter sessions by."
},
"assistantIdAny": {
"type": "string",
"description": "Filter by multiple assistant IDs. Provide as comma-separated values.",
"example": "assistant-1,assistant-2,assistant-3"
},
"squadId": {
"type": "string",
"description": "This is the ID of the squad to filter sessions by."
},
"workflowId": {
"type": "string",
"description": "This is the ID of the workflow to filter sessions by."
},
"customer": {
"description": "This is the customer information to filter by.",
"allOf": [
{
"$ref": "#/components/schemas/CreateCustomerDTO"
}
]
},
"customerNumberAny": {
"type": "string",
"description": "Filter by any of the specified customer phone numbers (comma-separated).",
"example": "+1234567890,+0987654321"
},
"phoneNumberId": {
"type": "string",
"description": "This will return sessions with the specified phoneNumberId."
},
"phoneNumberIdAny": {
"description": "This will return sessions with any of the specified phoneNumberIds.",
"type": "array",
"items": {
"type": "string"
}
},
"page": {
"type": "number",
"description": "This is the page number to return. Defaults to 1.",
"minimum": 1
},
"sortOrder": {
"type": "string",
"description": "This is the sort order for pagination. Defaults to 'DESC'.",
"enum": [
"ASC",
"DESC"
]
},
"sortBy": {
"type": "string",
"description": "This is the column to sort by. Defaults to 'createdAt'.",
"enum": [
"createdAt",
"duration",
"cost"
]
},
"limit": {
"type": "number",
"description": "This is the maximum number of items to return. Defaults to 100.",
"minimum": 0,
"maximum": 1000
},
"createdAtGt": {
"format": "date-time",
"type": "string",
"description": "This will return items where the createdAt is greater than the specified value."
},
"createdAtLt": {
"format": "date-time",
"type": "string",
"description": "This will return items where the createdAt is less than the specified value."
},
"createdAtGe": {
"format": "date-time",
"type": "string",
"description": "This will return items where the createdAt is greater than or equal to the specified value."
},
"createdAtLe": {
"format": "date-time",
"type": "string",
"description": "This will return items where the createdAt is less than or equal to the specified value."
},
"updatedAtGt": {
"format": "date-time",
"type": "string",
"description": "This will return items where the updatedAt is greater than the specified value."
},
"updatedAtLt": {
"format": "date-time",
"type": "string",
"description": "This will return items where the updatedAt is less than the specified value."
},
"updatedAtGe": {
"format": "date-time",
"type": "string",
"description": "This will return items where the updatedAt is greater than or equal to the specified value."
},
"updatedAtLe": {
"format": "date-time",
"type": "string",
"description": "This will return items where the updatedAt is less than or equal to the specified value."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vapi-getsessionpaginateddto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.