Skip to main content
GET
/
api
/
v1
/
ghl
/
setup
/
agents
/
calendar
/
{calendar_id}
Get GHL Agent by Calendar
curl --request GET \
  --url https://api.ravan.ai/api/v1/ghl/setup/agents/calendar/{calendar_id} \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "agent_id": "id_123",
    "agent_name": "example",
    "calendar_id": "id_123",
    "is_active": true,
    "created_at": "example"
  }
}

​
Authorizations

​
X-Api-Key
string
required
Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header. Find or rotate it from your Ravan AI account settings.

​
Path Parameters

​
calendar_id
string
required
The unique calendar ID from the connected scheduling provider.

​
Response

​
success
boolean
Whether the request succeeded.
​
message
string
Human-readable status message.
​
data
object
data field.
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "agent_id": "id_123",
    "agent_name": "example",
    "calendar_id": "id_123",
    "is_active": true,
    "created_at": "example"
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
calendar_id
string
required

GHL Calendar ID

Response

200 - application/json

Successful response

​
success
boolean
​
message
string
​
data
object