List Squads
Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
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
idAny
Return only squads matching the provided ids
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
members
This is the list of assistants that make up the squad.
The call will start with the first assistant in the list.
id
This is the unique identifier for the squad.
orgId
This is the unique identifier for the org that this squad belongs to.
createdAt
This is the ISO 8601 date-time string of when the squad was created.
updatedAt
This is the ISO 8601 date-time string of when the squad was last updated.
latestVersion
This is the latest version label (e.g. `v3`) of the squad in the version
history. `null` while the org is not yet onboarded to versioning, or for
squads that have not yet been published under it.
modelDeprecations
Read-only. Present only when a model this configuration uses is deprecated or retired in Vapi's model deprecation registry, judged on the day of the response. Each entry names the slot that carries the model (for example `model` or `model.fallbackModels[1]`), the deprecation and retirement dates as `YYYY-MM-DD` in UTC, and the recommended replacement model: the registry's replacement, followed through any further retirements as of the response date, so it names a model that is alive on that day. Ignored if sent back in a create or update request.
name
This is the name of the squad.
membersOverrides
This can be used to override all the assistants' settings and provide values for their template variables.
Both `membersOverrides` and `members[n].assistantOverrides` can be used together. First, `members[n].assistantOverrides` is applied. Then, `membersOverrides` is applied as a global override.