# Retrieve collection of document entities.

Use this endpoint to retrieve the collection of document information.

Endpoint: GET /documents
Version: 1.94.0
Security: oauth_auth_code

## Security:

  - `oauth_auth_code` (unknown)
    oauth2 scopes: read:documents

## Query parameters:

  - `page` (integer)
    The collection page number

  - `itemsPerPage` (integer)
    The number of items per page

  - `expand[]` (array)

  - `search` (string)
    Document search

  - `synchronized` (boolean)
    Filter documents by synchronization status with the current OAuth client

  - `patientEmailStatus` (array)
    Filter documents by how far the copy emailed to the patient got. Repeat the parameter to match several statuses (union). Documents never emailed to their patient match no status and are excluded whenever this filter is set.

  - `uuid` (string)
    Document uuid

  - `user.email` (string)
    Document user.email

  - `patient.email` (string)
    Document patient.email

  - `patient.id` (string)
    Document patient.id

  - `type` (string)
    Document type

  - `pdf` (string)
    Document pdf

  - `genericContactSpecialty` (string)
    Document genericContactSpecialty

  - `createdAt` (string)
    Document createdAt

  - `updatedAt` (string)
    Document updatedAt

  - `encounteredAt` (string)
    Document encounteredAt

  - `exists[encounteredAt]` (boolean)

  - `exists[meeting]` (boolean)

  - `exists[verifiedAt]` (boolean)

  - `user.uuid` (string)
    Document user.uuid

  - `patient.uuid` (string)
    Document patient.uuid

  - `audio.uuid` (string)
    Document audio.uuid

  - `isAnonymized` (string)
    Document isAnonymized

## Response 200:

  - `200` (unknown)
    Document collection

## Response 200 fields (application/json):

  - `uuid` (string)
    Document unique identifier.

  - `createdAt` (string)
    Document creation date.

  - `updatedAt` (string)
    Document update date.

  - `encounteredAt` (string | null)
    Document operation/cone beam specific date.

  - `user` (string)
    Document author.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `patient` (string | null)
    Document patient.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `type` (string | null)
    Document type.
    Enum: "operative_report", "referral_letter", "cone_beam_report", "patient_letter", "prescription", "initial_medical_certificate", "attendance_certificate", "contraindication_certificate", "lab_slip", "endo_report", "ortho_letter", "meeting_report", "intervention_report", "panoramic_report", "administrative_report", "free_letter", "null"

  - `pdf` (string | null)
    Document PDF file.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `isAnonymized` (boolean)
    Document anonymization status.

  - `emails` (array)
    Document emails.

  - `emails.uuid` (string)
    Email unique identifier.

  - `emails.sentAt` (string | null)
    Email sent date.

  - `emails.deliveredAt` (string | null)
    Email delivery date.

  - `emails.openedAt` (string | null)
    Email opening date.

  - `documentContacts` (array)
    Document contacts.

  - `documentContacts.uuid` (string | null)
    Document contact unique identifier.

  - `documentContacts.contact` (object)

  - `documentContacts.contact.uuid` (string)
    Contact unique identifier.

  - `documentContacts.contact.firstName` (string | null)
    Contact first name.

  - `documentContacts.contact.lastName` (string | null)
    Contact last name.

  - `genericContactSpecialty` (string | null)
    Generic contact specialty when no specific contact is selected (free text or predefined value).

  - `patientEmailStatus` (object | null)

  - `patientEmailStatus.status` (string, required)
    Enum: "sent", "received", "opened"

  - `patientEmailStatus.date` (string, required)

## Response 200 fields (application/ld+json):

  - `member` (array, required)

  - `member.@context` (any)

  - `member.@context.@vocab` (string, required)

  - `member.@context.hydra` (string, required)
    Enum: "http://www.w3.org/ns/hydra/core#"

  - `member.@id` (string, required)

  - `member.@type` (string, required)

  - `member.uuid` (string)
    Document unique identifier.

  - `member.createdAt` (string)
    Document creation date.

  - `member.updatedAt` (string)
    Document update date.

  - `member.encounteredAt` (string | null)
    Document operation/cone beam specific date.

  - `member.user` (string)
    Document author.
    Example: https://example.com/

  - `member.patient` (string | null)
    Document patient.
    Example: https://example.com/

  - `member.type` (string | null)
    Document type.
    Enum: "operative_report", "referral_letter", "cone_beam_report", "patient_letter", "prescription", "initial_medical_certificate", "attendance_certificate", "contraindication_certificate", "lab_slip", "endo_report", "ortho_letter", "meeting_report", "intervention_report", "panoramic_report", "administrative_report", "free_letter", "null"

  - `member.pdf` (string | null)
    Document PDF file.
    Example: https://example.com/

  - `member.isAnonymized` (boolean)
    Document anonymization status.

  - `member.emails` (array)
    Document emails.

  - `member.emails.uuid` (string)
    Email unique identifier.

  - `member.emails.sentAt` (string | null)
    Email sent date.

  - `member.emails.deliveredAt` (string | null)
    Email delivery date.

  - `member.emails.openedAt` (string | null)
    Email opening date.

  - `member.documentContacts` (array)
    Document contacts.

  - `member.documentContacts.uuid` (string | null)
    Document contact unique identifier.

  - `member.documentContacts.contact` (object)

  - `member.documentContacts.contact.@context` (any)

  - `member.documentContacts.contact.@context.@vocab` (string, required)

  - `member.documentContacts.contact.@context.hydra` (string, required)
    Enum: "http://www.w3.org/ns/hydra/core#"

  - `member.documentContacts.contact.@id` (string, required)

  - `member.documentContacts.contact.@type` (string, required)

  - `member.documentContacts.contact.uuid` (string)
    Contact unique identifier.

  - `member.documentContacts.contact.firstName` (string | null)
    Contact first name.

  - `member.documentContacts.contact.lastName` (string | null)
    Contact last name.

  - `member.genericContactSpecialty` (string | null)
    Generic contact specialty when no specific contact is selected (free text or predefined value).

  - `member.patientEmailStatus` (object | null)

  - `member.patientEmailStatus.status` (string, required)
    Enum: "sent", "received", "opened"

  - `member.patientEmailStatus.date` (string, required)

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/ld+json):

  - `@context` (any)

  - `@context.@vocab` (string, required)

  - `@context.hydra` (string, required)
    Enum: "http://www.w3.org/ns/hydra/core#"

  - `@id` (string, required)

  - `@type` (string, required)

  - `title` (string | null)
    A short, human-readable summary of the problem.

  - `detail` (string | null)
    A human-readable explanation specific to this occurrence of the problem.

  - `status` (integer | null)

  - `instance` (string | null)
    A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  - `type` (string)
    A URI reference that identifies the problem type

  - `description` (string | null)