> For the complete documentation index, see [llms.txt](https://docs.groundcover.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-entities.md).

# Query Infrastructure Entities

Retrieve the current state of infrastructure entities with gcQL.

### Endpoint

**POST** `/api/entities/v1/search`

Query the current state of infrastructure entities such as Pods, Nodes, and Deployments. This endpoint does not take a historical `start`/`end` range. Use the workload/cluster list examples for their time-scoped inventory views.

### Authentication

Send `Authorization: Bearer <YOUR_API_KEY>` and `X-Backend-Id: <YOUR_BACKEND_ID>`. JSON requests also require `Content-Type: application/json`. The examples use `https://api.groundcover.com`; use your deployment's API URL for a self-hosted installation.

### Request Body

| Field     | Type   | Required | Description                              |
| --------- | ------ | -------- | ---------------------------------------- |
| `query`   | string | Yes      | gcQL filter and pipeline.                |
| `sources` | array  | No       | Additional structured source conditions. |

### Example

```bash
curl --request POST 'https://api.groundcover.com/api/entities/v1/search' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Backend-Id: <YOUR_BACKEND_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "kind:Pod AND status_phase:Running | fields name, namespace, workload | limit 20"
}'
```

### Response

The response uses `{ "data": [...], "valueFieldHints": [...] }`. Rows contain the fields selected by the query; numeric aggregation columns are identified in `valueFieldHints`. See [Search Responses](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/search-v3-and-streaming.md) for the envelope format.

Use [field discovery](https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/discover-fields-and-metrics.md) with `type: "entities"` to find queryable fields. Availability depends on your backend's entity-search support; an unsupported backend returns an endpoint-unsupported error.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.groundcover.com/reference/remote-access-and-apis/api-examples/query-entities.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
