---
title: "List Documents"
method: GET
path: "/v1/clients/projects/{project_id}/documents"
tags: ["Documents"]
---

# List Documents

`GET /v1/clients/projects/{project_id}/documents`

## Request

- Base URL: `https://api.textmaster.com`
- URL: `https://api.textmaster.com/v1/clients/projects/{project_id}/documents`
- Auth: OAuth 2
  - Authorization code: `https://api.textmaster.com/oauth/authorize`
  - Token URL: `https://api.textmaster.com/oauth/token` scopes: `project:manage`, `project:read`, `project:write`

## Path parameters

- `project_id` string, required

## Query parameters

- `page` integer

## Response `200`

Lists Documents

- object
  - `total_pages` integer
  - `count` integer
  - `page` integer
  - `per_page` integer
  - `previous_page` integer, nullable
  - `next_page` integer, nullable
  - `documents` Document[]
    - `language_from` string
    - `language_to` string
    - `language_from_code` string
    - `language_to_code` string
    - `status` string
    - `skip_copyscape` boolean
    - `title` string
    - `instructions` string
    - `word_count` integer
    - `word_count_rule` integer
    - `keywords_repeat_count` integer
    - `deliver_work_as_file` boolean
    - `custom_data` object
    - `plagiarism_analysis` object
    - `written_words` integer
    - `type` string
    - `id` string
    - `project_id` string
    - `callback` object
      - `canceled` CallbackUrl
        - `url` string
        - `format` string
      - `completed` CallbackUrl
        - `url` string
        - `format` string
      - `copyscape` CallbackUrl
        - `url` string
        - `format` string
      - `counting_words` CallbackUrl
        - `url` string
        - `format` string
      - `in_progress` CallbackUrl
        - `url` string
        - `format` string
      - `in_review` CallbackUrl
        - `url` string
        - `format` string
      - `incomplete` CallbackUrl
        - `url` string
        - `format` string
      - `paused` CallbackUrl
        - `url` string
        - `format` string
      - `quality_control` CallbackUrl
        - `url` string
        - `format` string
      - `waiting_assignment` CallbackUrl
        - `url` string
        - `format` string
    - `reference` string
    - `ctype` string
    - `keyword_list` string
    - `satisfaction` integer, nullable
    - `completion` number
    - `can_post_message_to_author` boolean
    - `author_work` union
      - object
      - string
    - `author_id` string, nullable
    - `author_rating` integer
    - `original_content` string
    - `created_at` Date
      - `day` integer
      - `month` integer
      - `year` integer
      - `full` string
    - `updated_at` Date
      - `day` integer
      - `month` integer
      - `year` integer
      - `full` string
    - `completed_at` DateOrNull, nullable
      - `day` integer
      - `month` integer
      - `year` integer
      - `full` string

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/textmaster/apis/textmaster-api-v1.md) - [All operations](https://skmtc.dev/textmaster/apis/textmaster-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/textmaster/apis/textmaster-api-v1/revisions/cb8425b56de9?raw)