---
updatedAt: 2026-06-03T14:49:16.000Z
agentTools:
  projectIndex: https://askedgar.readme.io/llms.txt
---

# Read Overview

## Overview

Returns your organization name, tier, and the list of data endpoints your API key is licensed to call. Use this as a discovery probe before constructing a workflow — if an endpoint isn't in `available_endpoints`, calling it will 403.

Authenticated by API key; this endpoint is **not billed** and does not consume credits.

## When to use

* First call from a new integration to verify which data endpoints you can hit.
* Smoke-checking that an API key is valid and what tier it's bound to.
* Building a permissioned UI that hides endpoints the caller doesn't have.

## Response highlights

* `org_name` — your organization's display name (may be null for keys not bound to an org).
* `tier` — your subscription tier (e.g. `FREE`, `RETAIL`, `ENTERPRISE`).
* `available_endpoints` — sorted list of endpoint names (e.g. `reverse-splits`, `news`) you're authorized to call.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "AskEdgar API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://eapi.askedgar.io"
    }
  ],
  "paths": {
    "/v1/overview": {
      "get": {
        "tags": [
          "Account"
        ],
        "summary": "Read Overview",
        "operationId": "get_overview",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OverviewResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyHeader": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "OverviewResponse": {
        "properties": {
          "org_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Org Name"
          },
          "tier": {
            "$ref": "#/components/schemas/Tier"
          },
          "available_endpoints": {
            "items": {
              "type": "string"
            },
            "type": "array",
            "title": "Available Endpoints"
          }
        },
        "type": "object",
        "required": [
          "org_name",
          "tier",
          "available_endpoints"
        ],
        "title": "OverviewResponse"
      },
      "Tier": {
        "type": "string",
        "enum": [
          "FREE",
          "TRIAL",
          "RETAIL",
          "ENTERPRISE",
          "MASTER"
        ],
        "title": "Tier"
      }
    },
    "securitySchemes": {
      "ApiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "API-KEY"
      }
    }
  }
}
```