# Returns a list of documents based on filter criteria

**Query shape:** Prefer a **narrow** filter—combine scoping filters with `lastModified` or date bounds where supported. A very wide date range with no other scoping can **408** (timeout) on large tenants; retry with a smaller window or use cursor pagination (`lastId` with `lastModified`—see parameter descriptions).
**Empty results:** **200** with `data: []` means no documents matched; it does not indicate invalid filter values.
**responseFields:** Use only names allowed on this operation (see the `responseFields` parameter). Use `ALL` or the documented flat field list.
**Pagination:** The `page` query parameter is deprecated where `lastId` is supported; **`lastModified` / `lastId`** style pagination is preferred.

Endpoint: GET /v1/documents
Version: 191.0.3
Security: bearerAuth, oAuthSandbox

## Security:

  - `bearerAuth` (unknown)
    http bearer JWT

  - `oAuthSandbox` (unknown)
    oauth2

## Query parameters:

  - `responseFields` (string)
    A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported:

ALL - Returns all field names.

  - `filter` (string)
    Filter clauses for documents. General grammar and operators: the Public API filter documentation.
**Auto filter:** If you omit a date-limiting filter (such as `lastModified`), the server may apply one automatically; behavior can vary by deployment.
**Keys and operators (this endpoint)**
- `ownerOrganization.id` (`==`)
- `ownerPatient.id` (`==`)
- `ownerPerioExam.id` (`==`)
- `tags` (`->`)
Examples: `ownerOrganization.id==12`, `ownerPatient.id==12`, `ownerPerioExam.id==12`.

  - `page` (string)
    Page number for pagination control

  - `pageSize` (string)
    Page size for pagination control

  - `lastId` (string)
    the biggest documentId from previous page

## Header parameters:

  - `Organization-ID` (string, required)
    Organization context for the request. Must match the organization authorized by the access token.

## Response 200:

  - `200` (unknown)
    The request was successful

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (integer)
    Example: 1234

  - `data.name` (string, required)

  - `data.tags` (array)

  - `data.thumbNailId` (string)
    Example: thumbNailId Number

  - `data.mimeType` (string, required)
    Enum: "PDF", "JPEG", "PNG", "GIF", "DOC", "DOCX", "PPT", "PPTX", "XLS", "XLSX", "MSG", "HTML"

  - `data.guidName` (string)
    Example: name

  - `data.ownerType` (string)
    Enum: "Organization", "PerioExam", "Patient"

  - `data.storage` (object)

  - `data.storage.thumbnail` (string)

  - `data.storage.original` (string)

  - `data.storage.resized` (string)

  - `data.storage.cropped` (string)

  - `data.isInS3` (boolean)
    Example: true

  - `data.userDefinedDate` (string)
    Example: 2021-09-29

  - `data.ownerPatient` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.ownerPatient.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.ownerPatient.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.ownerPatient.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.ownerPerioExam` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.ownerPerioExam.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.ownerPerioExam.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.ownerPerioExam.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.ownerOrganization` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.ownerOrganization.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.ownerOrganization.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.ownerOrganization.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `warnings` (array)

  - `warnings.code` (string)

  - `warnings.title` (string)

  - `warnings.description` (string)

  - `warnings.source` (string)

  - `errors` (array)

  - `meta` (object)

  - `meta.pagination` (object)
    Pagination info
    Example: {"limit":10,"offset":0}

  - `meta.pagination.limit` (integer)
    Example: 10

  - `meta.pagination.offset` (integer)
    Example: 0

  - `meta.pagination.total` (integer)
    Example: 100

## Response 400:

  - `400` (unknown)
    The request was invalid or cannot be processed

## Response 401:

  - `401` (unknown)
    Authentication is required and has failed or has not been provided

## Response 403:

  - `403` (unknown)
    The request is understood, but it has been refused or access is not allowed

## Response 404:

  - `404` (unknown)
    The requested resource is either missing or does not exist

## Response 408:

  - `408` (unknown)
    The server timed out while processing the request

## Response 429:

  - `429` (unknown)
    Rate limit exceeded

## Response 500:

  - `500` (unknown)
    An unexpected error occurred

## Response 200 examples:

  - `default` (unknown)