Skip to main content
GET
/
public
/
v1
/
agents
/
{agentId}
Get agent
curl --request GET \
  --url https://api.callin.io/api/public/v1/agents/{agentId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": {
    "agentId": "<string>",
    "name": "<string>",
    "direction": "outbound",
    "tags": [
      "<string>"
    ],
    "platformSettings": {
      "callActions": {
        "smartOptOut": false,
        "issueTracking": false,
        "postCallWebhook": "<string>",
        "postCallEmail": {
          "enabled": false,
          "emailConfiguration": {}
        },
        "scheduleOnCalendar": {
          "enabled": false,
          "provider": "google",
          "eventsIds": [
            "<string>"
          ]
        }
      },
      "widget": {},
      "dataCollection": {
        "entities": {},
        "storeData": false
      },
      "callRetry": {
        "retryCount": 123,
        "retryDelay": 123
      },
      "summaryLanguage": "<string>",
      "privacy": {
        "recordVoice": false
      },
      "telephony": {
        "numberRotationEnabled": false,
        "rotationNumbers": [
          "<string>"
        ],
        "callsPerNumber": 123,
        "stateRestrictionEnabled": false,
        "stateRestrictedNumbers": [
          "<string>"
        ]
      }
    },
    "phoneNumbers": [
      {
        "provider": "<string>",
        "number": "<string>",
        "label": "<string>"
      }
    ],
    "workflow": {
      "edges": {},
      "nodes": {},
      "preventSubagentLoops": false
    },
    "metadata": {
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": {
        "userId": "<string>",
        "userEmail": "<string>"
      }
    }
  }
}

Authorizations

x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Path Parameters

agentId
string
required

The unique identifier of the agent.

Response

Full agent details.

Full single-agent record including conversation and platform configuration.

success
boolean
Example:

true

data
object