Skip to navigation

Get Squad

Returns the squad identified by its ID.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the squad.

Response

memberslist of objects
This is the list of assistants that make up the squad. The call will start with the first assistant in the list.
idstring
This is the unique identifier for the squad.
orgIdstring
This is the unique identifier for the org that this squad belongs to.
createdAtdatetime

This is the ISO 8601 date-time string of when the squad was created.

updatedAtdatetime

This is the ISO 8601 date-time string of when the squad was last updated.

latestVersionstring or nullOptional

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.

modelDeprecationslist of objectsOptional

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 (for example model or model.fallbackModels[1]), provider, stored model, and deprecation and retirement dates as YYYY-MM-DD in UTC. replacementStatus is available with a replacementModel when a replacement can be recommended, or manual-action-required with no replacement model when eligibility is unknown or no eligible replacement exists. manual-action-required can be transient when compliance context is unavailable; re-fetch before acting. HIPAA-required configurations, sparse drafts, and squads with unresolved assistant references currently require manual action. HIPAA requirements include the organization and assistant settings, including HIPAA with data retention. Recommendations reflect the response-time decision; they do not confirm a swap or authorize future execution. Examples: an available recommendation includes {"replacementStatus":"available","replacementModel":"gpt-5"}; a blocked recommendation includes {"replacementStatus":"manual-action-required"}. Ignored if sent back in a create or update request.

namestringOptional
This is the name of the squad.
membersOverridesobjectOptional

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.