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

# Usage and capabilities

> Discover available v2 resources and read API usage totals.

# Usage and capabilities

Use capabilities for runtime discovery and usage reporting for operational visibility.

## Discover capabilities

`GET /v2/capabilities` returns resources, paths, available actions, and the read/write scopes attached to those resources.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -u "$CLIENT_ID:$CLIENT_SECRET" \
  "https://api.vantr.ai/v2/capabilities"
```

```json Response theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "success": true,
  "capabilities": [
    {
      "resource": "products",
      "path": "/v2/products",
      "actions": ["list", "get", "create", "update", "archive"],
      "scopes": {
        "read": "products.read",
        "write": "products.write"
      }
    },
    {
      "resource": "locations",
      "path": "/v2/locations",
      "actions": ["list", "get"],
      "scopes": {
        "read": "locations.read",
        "write": null
      }
    }
  ]
}
```

<ResponseField name="resource" type="string">
  Resource name, such as `products`, `categories`, `vendors`, or `locations`.
</ResponseField>

<ResponseField name="path" type="string">
  Base path for the resource.
</ResponseField>

<ResponseField name="actions" type="string[]">
  Actions exposed for that resource in the current v2 API.
</ResponseField>

<ResponseField name="scopes" type="object">
  Read and write scopes used by the resource.
</ResponseField>

## Read usage totals

`GET /v2/usage` returns API usage totals for the tenant. Pass `endpoint` when you want to filter by a specific operation label.

<CodeGroup>
  ```bash All public API usage theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -u "$CLIENT_ID:$CLIENT_SECRET" \
    "https://api.vantr.ai/v2/usage"
  ```

  ```bash Filter one endpoint theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -u "$CLIENT_ID:$CLIENT_SECRET" \
    "https://api.vantr.ai/v2/usage?endpoint=GET%20%2Fv2%2Fproducts"
  ```
</CodeGroup>

<ParamField query="endpoint" type="string">
  Optional endpoint label, for example `GET /v2/products`.
</ParamField>

## Operational checks

<AccordionGroup>
  <Accordion title="Check application access during setup" icon="shield-check">
    Call `/v2/capabilities` after creating a developer application. If a resource is missing or an action is unavailable, update the application scopes before continuing.
  </Accordion>

  <Accordion title="Monitor usage by workflow" icon="activity">
    Use `/v2/usage` from an operations job to compare expected sync volume with observed API usage.
  </Accordion>

  <Accordion title="Use read calls for smoke tests" icon="test-tube">
    List locations or capabilities before running write workflows. These calls validate auth and tenant binding without changing records.
  </Accordion>
</AccordionGroup>

## Related reference

<Columns cols={2}>
  <Card title="Get capabilities" icon="waypoints" href="/api-reference/capabilities/get-api-capabilities">
    Discover resources, actions, and scopes.
  </Card>

  <Card title="Read usage" icon="chart-no-axes-combined" href="/api-reference/usage/get-public-api-usage">
    Read tenant API usage totals.
  </Card>
</Columns>