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

# Current stats

> Resolves the location from the `X-Vendor-Request-Key` header (slot); no `location_id` in the path.

This endpoint retrieves current stats for a specific location.

#### Parameters

- balance_type (optional): Which account balances to include. "positive" returns only debit balances, "negative" returns only credit balances, "all" returns both. Defaults to "all".



## OpenAPI

````yaml https://app.teamcaredental.com/openapi-vendors-v2.json get /current/stats
openapi: 3.1.0
info:
  title: TeamCare Vendor API (v2)
  version: 2.0.0
  description: >-
    Version 2 of the TeamCare Vendor API. HIPAA-compliant and opt-in.


    ## What changed from v1


    The data endpoints and response shapes are identical to v1 — **only how you
    address a location changes.** In v1 the location lived in every URL
    (`/locations/{location_id}/patients`). In v2 you request a **slot** for a
    location once, then send the returned `request_key` in the
    `X-Vendor-Request-Key` header; `location_id` is gone from the data routes.


    ## Request cycle


    1. `POST /auth/token` → JWT (unchanged from v1).

    2. `GET /organizations`, `GET /locations` → pick a `location_id`.

    3. `POST /locations/{location_id}/slots` → `{ request_key, expires_at }`.

    4. Call any data endpoint with header `X-Vendor-Request-Key: <request_key>`
    (no `location_id` in the path).


    ## Minimal changes to migrate


    - Point your base URL at `https://api.teamcaredental.com/api/v2/vendors` (v2
    is served from `api.teamcaredental.com`, not `app.teamcaredental.com`).

    - Call the slot endpoint **once per location**.

    - Drop `/locations/{location_id}` from your data paths and add the
    `X-Vendor-Request-Key` header.

    - Everything else — authentication, Ransack `q` filters, pagination,
    response shapes — is unchanged.


    ## Slot validity, cooldown & quota


    - **Validity:** a `request_key` is valid for **6 hours** — the same lifetime
    as the access token. After that it stops authorizing and you must request a
    new slot.

    - **Cooldown:** you can only re-request the **same** location's slot once
    every **2 minutes**. Within the cooldown the slot endpoint returns `429`
    with a `retry_after` (seconds).

    - **Quota:** each firm may hold up to its `concurrent_slots` quota (default
    **10**) active request keys at once, so data for at most 10 locations can be
    pulled concurrently. Requesting an 11th slot trims the oldest key, so its
    `request_key` stops authorizing immediately and any in-flight requests using
    it fail with `401`. To raise the quota above 10, contact TeamCare support.

    - **Rate limit:** the slot endpoint accepts at most 10 requests per 10
    seconds per token.


    ## Recommended usage


    Request a slot for a location and pull **all** of that location's data in
    one pass before moving on — don't re-request slots per call or churn between
    locations. If you fan out across locations in parallel, keep the fan-out at
    or below your quota: once an 11th slot is requested, the oldest
    `request_key` is invalidated even if a sync is still running on it.


    See the [changelog](https://docs.teamcaredental.com/changelog) for the full
    list of changes from v1.
servers:
  - url: https://api.teamcaredental.com/api/v2/vendors
security:
  - bearerAuth: []
paths:
  /current/stats:
    get:
      tags:
        - Stats
      summary: Current stats
      description: >-
        Resolves the location from the `X-Vendor-Request-Key` header (slot); no
        `location_id` in the path.


        This endpoint retrieves current stats for a specific location.


        #### Parameters


        - balance_type (optional): Which account balances to include. "positive"
        returns only debit balances, "negative" returns only credit balances,
        "all" returns both. Defaults to "all".
      operationId: locations_resources_stats_current
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  reactivation:
                    type: object
                    properties:
                      total:
                        type: number
                      had_hygiene:
                        type: number
                      never_had_hygiene:
                        type: number
                      eligible:
                        type: number
                      eligible_hygiene:
                        type: number
                      active_call_cycle:
                        type: number
                      attempts_mtd:
                        type: number
                      attended_mtd:
                        type: number
                  accounts_receivable:
                    type: array
                    items:
                      type: object
                      properties:
                        category:
                          type: string
                        number_of_patients:
                          type: number
                        total_balance:
                          type: string
                        average_balance:
                          type: number
                  average_production_per_patient:
                    type: object
                    properties:
                      per_patient_value:
                        type: string
                        example: float
                      production:
                        type: string
                        example: float
                      hygiene_visits:
                        type: string
                        example: float
              example:
                reactivation:
                  total: 0
                  had_hygiene: 0
                  never_had_hygiene: 0
                  eligible: 0
                  eligible_hygiene: 0
                  active_call_cycle: 0
                  attempts_mtd: 0
                  attended_mtd: 0
                accounts_receivable:
                  - category: string
                    number_of_patients: 0
                    total_balance: string
                    average_balance: 0
                  - category: string
                    number_of_patients: 0
                    total_balance: string
                    average_balance: 0
                  - category: string
                    number_of_patients: 0
                    total_balance: string
                    average_balance: 0
                  - category: string
                    number_of_patients: 0
                    total_balance: string
                    average_balance: 0
                average_production_per_patient:
                  per_patient_value: float
                  production: float
                  hygiene_visits: float
        '401':
          description: >-
            Missing/invalid/expired JWT, or missing/invalid/expired
            X-Vendor-Request-Key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              example:
                errors: not authorized
        '403':
          description: The credential may not access this resource.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              example:
                errors: access Denied
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              example:
                errors: resource not found
        '422':
          description: The request could not be processed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
              example:
                errors: ...
      security:
        - bearerAuth: []
          vendorRequestKey: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT returned by POST /auth/token. Valid for six hours.
    vendorRequestKey:
      type: apiKey
      in: header
      name: X-Vendor-Request-Key
      description: >-
        Request key returned by POST /locations/{location_id}/slots. Identifies
        the practice for a data request; valid for 6 hours (the access token's
        lifetime) and subject to the firm's concurrent-slot quota.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.