Get GHL Agent by Calendar

Get GHL Agent by Calendar.

GET /api/v1/ghl/setup/agents/calendar/{calendar_id}

Get GHL Agent by Calendar

cURL

curl --request GET \
  --url https://api.ravan.ai/api/v1/ghl/setup/agents/calendar/{calendar_id} \
  --header 'X-Api-Key: <api-key>'

200

{
  "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. Find it in your RavanAi.

---

Path Parameters

calendar_id · string · required

GHL Calendar ID

---

Response

success · boolean

Whether the request succeeded.

message · string

Human-readable status message.

data · object

data field.

Show data

agent_id · string

agent_id field.

agent_name · string

agent_name field.

calendar_id · string

calendar_id field.

is_active · boolean

is_active field.

created_at · string

created_at field.

200

{
  "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

Show child attributes