Skip to main content
GET
/
api
/
v1
/
squads
/
{squadId}
Get squad details
curl --request GET \
  --url https://prod.featherhq.com/api/v1/squads/{squadId} \
  --header 'X-API-Key: <api-key>'
{
  "squad": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "entrypointAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entrypointAgent": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "agentType": "CALL",
      "description": "<string>"
    },
    "archived": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "transferRules": [
      null
    ],
    "phoneNumbers": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phoneNumber": "<string>"
      }
    ],
    "memberAgents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "agentType": "CALL"
      }
    ],
    "stats": {
      "totalCalls": 123,
      "totalTransfers": 123,
      "avgCallDuration": 123
    }
  }
}

Authorizations

X-API-Key
string
header
required

Path Parameters

squadId
string<uuid>
required

Response

Squad retrieved successfully

squad
object
required