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

# Public API-KEY

<Note>
  An <code>X-API-KEY</code> is required to authenticate requests to nearly all public endpoints.\
  This endpoint provides the key.
</Note>

<CardGroup>
  <Card title="Method" icon="puzzle-piece">
    `GET`
  </Card>

  <Card title="Endpoint" icon="link">
    `api/public/keys/hint`
  </Card>
</CardGroup>

<ParamField header="X-Api-Key" type="string" required>
  The agency's API key for authorization. Contact an admin to get one.
</ParamField>

<RequestExample>
  ```bash Request theme={null}
    curl --request GET \
      --url https://api.growthchannel.io/keys/hint/?agency_id=544
  ```
</RequestExample>

<ParamField path="agency_id" type="number" example="544" required>
  The unique identifier for the agency <code>?agency\_id=544</code>
</ParamField>

## Responses

<Tabs>
  <Tab title="200 OK">
    ```json theme={null}
    {
      "key_hint": "aY5Q" // last 4 characters
    }
    ```
  </Tab>

  <Tab title="404 Not Found">
    ```json theme={null}
    {
      "error": {
          "code": "NOT_FOUND",
          "message": "Agency not found",
          "details": {
              "field": "agency_id",
              "value": "544"
          },
          "request_id": "4b7bd3b3-21fa-47ae-8369-78e658408a51"
      }
    }
    ```
  </Tab>
</Tabs>