# List Documents

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/users/me/operations/documents:
    get:
      summary: List Documents
      deprecated: false
      description: >-
        Returns list of [Documents](doc-341730#document-model) shared with
        current user.


        ## Query Parameters


        Parameter              | Type        | Default   | Description

        --------------         | ----------- | --------- | -----------

        per_page               | integer     | 100       | Number of results to
        be returned per request (100 is the maximum)

        page_no                | integer     | 1         | Number of results
        page

        confirmable            | boolean     | null      | When true, returns
        only confirmable Documents - and vice versa

        search                 | string      | null      | When present, returns
        only Documents that match the given string

        requiring_confirmation | boolean     | null      | When present, returns
        only Documents that require confirmation (are confirmable and are not
        confirmed)

        access | enum: `['public', 'private']` | null     | When present,
        returns only Documents having given type of accesssort_by               
        | enum: `['title', 'created_at']` | null      | Sorting by property

        sort_direction         | enum: `['asc', 'desc']`         | asc       |
        Sort direction


        ## Example


        ```shell

        curl -X GET \

        "https://api.mpc.placewise.com/v1/users/me/operations/documents" \
          -H 'authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyOE' \
          -H 'content-type: application/json' \
          -H 'x-loyalty-club-slug: infinity-mall' \
          -H 'x-user-agent: CURL manual test'
        ```


        When successful, returns object containing
        [documents](doc-341730#document-model) and [PaginationInfo](doc-341638)


        ```json

        {
          "documents": [], // List of documents - see 'Document model'
          "pagination_info": {} // Pagination info - see 'Pagination info'
        }

        ```
      tags:
        - API Reference/Operations API/Tenant API/Documents
      parameters:
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
        - name: X-Store-Id
          in: header
          description: 'Store id associated with given user role (e.g. Store Owner). '
          required: false
          example: '{{STORE_ID}}'
          schema:
            type: integer
            default: '{{STORE_ID}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Operations API/Tenant API/Documents
      x-apidog-status: pending
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511319-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```