---
title: "Get company user usage metrics"
method: GET
path: "/user-usage-by-company/metrics"
tags: ["entitlements"]
---

# Get company user usage metrics

`GET /user-usage-by-company/metrics`

## Query parameters

- `company_id` string, required — Company to list available metrics for
- `end_time` string, date-time — End of the usage window (exclusive); defaults to now
- `start_time` string, date-time — Start of the usage window; defaults to 30 days before the end

## Response `200`

OK

- object
  - `data` CompanyUserUsageMetricsResponseData, required
    - `end_time` string, date-time, required — End of the usage window (exclusive)
    - `features` FeatureResponseData[], required — Event-based features the company has user-attributed usage for in the window; a feature with usage but no entitlement is still listed
      - `created_at` string, date-time, required
      - `description` string, required
      - `event_subtype` string, nullable
      - `feature_type` 'boolean' | 'event' | 'license' | 'trait', required
      - `icon` string, required
      - `id` string, required
      - `license_id` string, nullable — The license sold through this feature. Set only on features of type license, and created automatically with them.
      - `lifecycle_phase` 'add_on' | 'alpha' | 'beta' | 'deprecated' | 'ga' | 'inactive' | 'in_plan' | 'internal_testing' | 'legacy'
      - `maintainer_account_member_id` string, nullable
      - `name` string, required
      - `plural_name` string, nullable
      - `singular_name` string, nullable
      - `trait_id` string, nullable
      - `updated_at` string, date-time, required
      - `usage_limit_trait_id` string, nullable — Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
    - `has_credits` boolean, required — Whether the company consumed any credits in the window
    - `start_time` string, date-time, required — Start of the usage window
  - `params` object, required — Input parameters
    - `company_id` string — Company to list available metrics for
    - `end_time` string, date-time — End of the usage window (exclusive); defaults to now
    - `start_time` string, date-time — Start of the usage window; defaults to 30 days before the end

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

## Changes

- **2026-09-28** `eb32b6d1c979` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/schematichq/apis/schematic-api/changes/user-usage-by-company/metrics/get.md)

---

[API](https://skmtc.dev/schematichq/apis/schematic-api.md) · [All operations](https://skmtc.dev/schematichq/apis/schematic-api/llms.txt) · [OpenAPI document](https://skmtc.dev/schematichq/apis/schematic-api/revisions/2c923705baad?raw)
