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>"
}
}
}
}Returns the full configuration and metadata for a single agent by its ID.
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>"
}
}
}
}Send your Callin API key in the x-api-key header.
The unique identifier of the agent.
Was this page helpful?