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

# Understanding API Endpoints

> Quick overview of Shovels API endpoints. For complete details, see the API Reference documentation.

**An API endpoint is a specific URL that represents a particular function or query.** The Shovels API (v2) provides access to permits, contractors, addresses, and supporting resources. For complete endpoint documentation, see the [API Reference](/api-reference).

## Main Endpoint Categories

| Category        | Base Path           | Purpose                                  |
| --------------- | ------------------- | ---------------------------------------- |
| **Permits**     | `/v2/permits/*`     | Building permit data                     |
| **Contractors** | `/v2/contractors/*` | Contractor information                   |
| **Addresses**   | `/v2/addresses/*`   | Address resolution to geo\_ids           |
| **Lists**       | `/v2/lists/*`       | Predefined values (tags, property types) |
| **Meta**        | `/v2/meta/*`        | API metadata and release info            |

## Search vs Detail Endpoints

* **Search endpoints** return multiple records based on filters
* **Detail endpoints** return specific records by ID

<Info>
  Search responses include full detail payloads—you usually don't need a separate detail call.
</Info>

## Full Documentation

For complete endpoint details, parameters, and interactive testing:

* [API Reference](/api-reference) - Full endpoint documentation with playground
* [API Introduction](/docs/shovels-api-introduction) - Authentication, pagination, and usage tips

## Related Articles

* [Query parameters explained](/docs/knowledge-base/api/basics/query-parameters)
* [How do API credits work?](/docs/knowledge-base/api/basics/request-counts)