GHL Setup Status

GHL Setup Status.

GET /api/v1/ghl/setup/status

GHL Setup Status

cURL

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

200

{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "ghl_connected": true,
    "location_id": "id_123",
    "company_id": "id_123",
    "token_valid": true,
    "agents_created": true,
    "agent_count": 1,
    "setup_complete": true,
    "message": "Request completed successfully",
    "next_step": ""
  }
}

Authorizations

X-Api-Key · string · required

Your Agni API key. Find it in your RavanAi.

---

Response

success · boolean

Whether the request succeeded.

message · string

Human-readable status message.

data · object

Current GHL setup status details.

Show data

ghl_connected · boolean

ghl_connected field.

location_id · string

location_id field.

company_id · string

company_id field.

token_valid · boolean

token_valid field.

agents_created · boolean

agents_created field.

agent_count · integer

agent_count field.

setup_complete · boolean

setup_complete field.

message · string

message field.

next_step · string

One of: CONNECT_GHL, CREATE_AGENT, or empty string when fully set up

next_step values:

• CONNECT_GHL: GHL is not connected yet.
• CREATE_AGENT: Connected, but no agents have calendars assigned.
• "" (empty string): Setup is complete.

200

{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "ghl_connected": true,
    "location_id": "id_123",
    "company_id": "id_123",
    "token_valid": true,
    "agents_created": true,
    "agent_count": 1,
    "setup_complete": true,
    "message": "Request completed successfully",
    "next_step": ""
  }
}

Authorizations

X-Api-Key · string · header · required

Response

200 - application/json

Successful response

success · boolean

message · string

data · object

Show child attributes