> ## 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.

# Reactivation attended

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

This endpoint retrieves reactivation values for a specific location and for a specific duration.

#### Parameters

- date (required): The reference date representing when the first treatment was performed.
- duration (optional): The time period (in days) to look up data within, starting from the given date.
- submitted_by_id (optional): Identifies the provider who submitted the appointments.
- q[exam_type_filter] (optional): A parameter to specify the exam type that can be "limited", "comprehensive" or "periodic".
- q[appointment_exam_provider_id_in] (optional): A parameter to specify the provider ids of exams to search with given in array.
- q[appointment_provider_id_in] (optional): A parameter to specify the provider ids of appointments to search with given in array.



## OpenAPI

````yaml https://app.teamcaredental.com/openapi-vendors-v2.json get /patients/reactivation_attended
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:
  /patients/reactivation_attended:
    get:
      tags:
        - Metrics
      summary: Reactivation attended
      description: >-
        Resolves the location from the `X-Vendor-Request-Key` header (slot); no
        `location_id` in the path.


        This endpoint retrieves reactivation values for a specific location and
        for a specific duration.


        #### Parameters


        - date (required): The reference date representing when the first
        treatment was performed.

        - duration (optional): The time period (in days) to look up data within,
        starting from the given date.

        - submitted_by_id (optional): Identifies the provider who submitted the
        appointments.

        - q[exam_type_filter] (optional): A parameter to specify the exam type
        that can be "limited", "comprehensive" or "periodic".

        - q[appointment_exam_provider_id_in] (optional): A parameter to specify
        the provider ids of exams to search with given in array.

        - q[appointment_provider_id_in] (optional): A parameter to specify the
        provider ids of appointments to search with given in array.
      operationId: locations_resources_patients_metrics_reactivation_attended
      parameters:
        - name: date
          in: query
          required: true
          description: >-
            The reference date representing when the first treatment was
            performed.
          schema:
            type: string
            format: date
            example: '2024-03-01'
        - name: duration
          in: query
          required: false
          schema:
            type: integer
            example: 90
          description: >-
            The time period (in days) to look up data within, starting from the
            given date.
        - name: submitted_by_id
          in: query
          required: false
          schema:
            type: integer
            example: 33
          description: Identifies the provider who submitted the appointments.
        - name: q
          in: query
          required: false
          style: deepObject
          explode: true
          schema:
            type: object
            properties:
              exam_type_filter:
                type: string
                example: ''
                description: >-
                  A parameter to specify the exam type that can be "limited",
                  "comprehensive" or "periodic".
              appointment_exam_provider_id_in:
                type: array
                items: {}
                description: >-
                  A parameter to specify the provider ids of exams to search
                  with given in array.
              appointment_provider_id_in:
                type: array
                items: {}
                description: >-
                  A parameter to specify the provider ids of appointments to
                  search with given in array.
          example:
            exam_type_filter: ''
            appointment_exam_provider_id_in: []
            appointment_provider_id_in: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  patients:
                    type: number
                  attended_production:
                    type: number
                  total:
                    type: number
                  30_days_production:
                    type: number
              example:
                patients: 0
                attended_production: 0
                total: 0
                30_days_production: 0
        '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.