> ## 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. # List patients > Resolves the location from the `X-Vendor-Request-Key` header (slot); no `location_id` in the path. This endpoint retrieves patients for a specific location. #### Parameters - after: A parameter to specify the cursor for pagination. - items: A parameter to specify the number of items to be returned. - The `q[first_treatment_performed_at]` field determines whether a record qualifies as a new patient. To retrieve a list of new patients, you can specify a date range for this field using the example format provided. - The `q[fetch_modified_since]` is used to capture the delta changes, pass the datetime in UTC as shown in example below ```json { "q": { "first_treatment_performed_at_gteq": "2001-01-01", "first_treatment_performed_at_lteq": "2024-01-31", "fetch_modified_since": "2025-12-02T01:58:00.164Z" } } ``` ## OpenAPI ````yaml https://app.teamcaredental.com/openapi-vendors-v2.json get /patients 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: ` (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: get: tags: - Patients summary: List patients description: >- Resolves the location from the `X-Vendor-Request-Key` header (slot); no `location_id` in the path. This endpoint retrieves patients for a specific location. #### Parameters - after: A parameter to specify the cursor for pagination. - items: A parameter to specify the number of items to be returned. - The `q[first_treatment_performed_at]` field determines whether a record qualifies as a new patient. To retrieve a list of new patients, you can specify a date range for this field using the example format provided. - The `q[fetch_modified_since]` is used to capture the delta changes, pass the datetime in UTC as shown in example below ```json { "q": { "first_treatment_performed_at_gteq": "2001-01-01", "first_treatment_performed_at_lteq": "2024-01-31", "fetch_modified_since": "2025-12-02T01:58:00.164Z" } } ``` operationId: locations_resources_patients_list parameters: - name: after in: query required: false description: A parameter to specify the cursor for pagination. schema: type: integer example: 2952007 - name: items in: query required: false description: A parameter to specify the number of items to be returned. schema: type: integer - name: q in: query required: false style: deepObject explode: true schema: type: object properties: first_name_eq: type: string example: Keith last_name_eq: type: string example: Waszzz first_treatment_performed_at_gteq: type: string format: date example: '2001-01-01' first_treatment_performed_at_lteq: type: string format: date example: '2024-01-31' fetch_modified_since: type: string format: date-time example: '2025-12-02T01:58:00.164Z' example: first_name_eq: Keith last_name_eq: Waszzz responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: string type: type: string attributes: type: object properties: first_name: type: string last_name: type: string middle_name: type: string example: string or null address_line1: type: string address_line2: type: string example: string or null city: type: string state: type: string zip_code: type: string latitude: type: string example: number or null longitude: type: string example: number or null status: type: string gender: type: string mobile_phone: type: string home_phone: type: string work_phone: type: string other_phone: type: string name: type: string pagy: type: object properties: has_more: type: boolean items: type: number example: data: - id: string type: string attributes: first_name: string last_name: string middle_name: string or null address_line1: string address_line2: string or null city: string state: string zip_code: string latitude: number or null longitude: number or null status: string gender: string mobile_phone: string home_phone: string work_phone: string other_phone: string name: string pagy: has_more: true items: 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.