> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ravan.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# GHL Setup Status

> GHL Setup Status.

### Authorizations

<ParamField header="X-Api-Key" type="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.
</ParamField>

***

### Response

<ResponseField name="success" type="boolean">
  Whether the request succeeded.
</ResponseField>

<ResponseField name="message" type="string">
  Human-readable status message.
</ResponseField>

<ResponseField name="data" type="object">
  Current GHL setup status details.

  <Expandable title="data">
    <ResponseField name="ghl_connected" type="boolean">
      ghl\_connected field.
    </ResponseField>

    <ResponseField name="location_id" type="string">
      location\_id field.
    </ResponseField>

    <ResponseField name="company_id" type="string">
      company\_id field.
    </ResponseField>

    <ResponseField name="token_valid" type="boolean">
      token\_valid field.
    </ResponseField>

    <ResponseField name="agents_created" type="boolean">
      agents\_created field.
    </ResponseField>

    <ResponseField name="agent_count" type="integer">
      agent\_count field.
    </ResponseField>

    <ResponseField name="setup_complete" type="boolean">
      setup\_complete field.
    </ResponseField>

    <ResponseField name="message" type="string">
      message field.
    </ResponseField>

    <ResponseField name="next_step" type="string">
      One of: CONNECT\_GHL, CREATE\_AGENT, or empty string when fully set up
    </ResponseField>
  </Expandable>
</ResponseField>

`next_step` values:

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

<ResponseExample>
  ```json 200 theme={null}
  {
    "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": ""
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /api/v1/ghl/setup/status
openapi: 3.0.1
info:
  title: Agni API
  version: 1.0.0
  description: >-
    Agni API for managing agents, tools, widget settings, telephony, and
    integrations.
servers:
  - url: https://api.ravan.ai
security:
  - X-Api-Key: []
tags:
  - name: AgentService
  - name: AgentToolService
  - name: WidgetSettingsService
  - name: PhoneService
  - name: AppointmentService
  - name: GHLService
  - name: CalComService
  - name: CampaignService
  - name: ContactService
  - name: CallingService
  - name: RAGService
  - name: ModelService
  - name: HealthService
paths:
  /api/v1/ghl/setup/status:
    get:
      tags:
        - GHLService
      summary: GHL Setup Status
      operationId: GHLSetupStatus
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GHLSetupStatusResponse'
components:
  schemas:
    GHLSetupStatusResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            ghl_connected:
              type: boolean
            location_id:
              type: string
            company_id:
              type: string
            token_valid:
              type: boolean
            agents_created:
              type: boolean
            agent_count:
              type: integer
            setup_complete:
              type: boolean
            message:
              type: string
            next_step:
              type: string
              description: >-
                One of: CONNECT_GHL, CREATE_AGENT, or empty string when fully
                set up
  securitySchemes:
    X-Api-Key:
      type: apiKey
      in: header
      name: X-Api-Key

````