Skip to main content
GET
/
api
/
v1
/
squads
/
{squadId}
/
transfer-rules
List transfer rules
curl --request GET \
  --url https://prod.featherhq.com/api/v1/squads/{squadId}/transfer-rules \
  --header 'X-API-Key: <api-key>'
{
  "transferRules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "squadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fromAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "toAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "allowManualTrigger": true,
      "toolDescription": "<string>",
      "variables": [
        {
          "name": "<string>",
          "description": "<string>",
          "required": true
        }
      ],
      "speakBeforeTransfer": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "fromAgent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "toAgent": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.featherhq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
squadId
string<uuid>
required

Query Parameters

​
fromAgentId
string<uuid>

Response

Transfer rules retrieved successfully

​
transferRules
object[]
required