---
title: "List Projects"
method: GET
path: "/v1/clients/projects"
tags: ["Projects"]
---

# List Projects

`GET /v1/clients/projects`

## Request

- Base URL: `https://api.textmaster.com`
- URL: `https://api.textmaster.com/v1/clients/projects`
- 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`

## Query parameters

- `page` integer

## Response `200`

Lists Projects

- object
  - `total_pages` integer
  - `count` integer
  - `page` integer
  - `per_page` integer
  - `previous_page` integer, nullable
  - `next_page` integer, nullable
  - `projects` Project[]
    - `id` string
    - `name` string
    - `language_from` string
    - `language_to` string
    - `language_from_code` string
    - `language_to_code` string
    - `category` 'C001' | 'C002' | 'C003' | 'C004' | 'C005' | 'C006' | 'C007' | 'C008' | 'C009' | 'C010' | 'C011' | 'C012' | 'C013' | 'C014' | 'C015' | 'C016' | 'C017' | 'C018' | 'C019' | 'C020' | 'C021' | 'C022' | 'C023' | 'C024' | 'C025' | 'C026' | 'C027' | 'C028' | 'C029' | 'C030' | 'C031' | 'C032' | 'C033' | 'C034'
    - `vocabulary_type` 'not_specified' | 'popular' | 'technical' | 'fictional'
    - `target_reader_groups` 'not_specified' | 'children' | 'teenager' | 'young_adults' | 'adults' | 'old_adults'
    - `grammatical_person` 'not_specified' | 'first_person_singular' | 'second_person_singular' | 'third_person_singular_masculine' | 'third_person_singular_feminine' | 'third_person_singular_neuter' | 'first_person_plural' | 'second_person_plural' | 'third_person_plural'
    - `custom_data` object
    - `project_briefing` string
    - `project_briefing_is_rich` boolean
    - `priority` number
    - `status` 'in_creation' | 'in_progress' | 'in_review' | 'paused' | 'completed' | 'canceled'
    - `total_word_count` integer
    - `documents_statuses` object
      - `in_creation` integer
      - `waiting_assignment` integer
      - `in_progress` integer
      - `in_review` integer
      - `incomplete` integer
      - `completed` integer
      - `paused` integer
      - `canceled` integer
      - `quality_control` integer
      - `copyscape` integer
      - `counting_words` integer
      - `in_extra_review` integer
    - `progress` number
    - `same_author_must_do_entire_project` boolean
    - `callback` CallbackUrl
      - `url` string
      - `format` string
    - `external_id` string, nullable
    - `multi_project_id` string, nullable
    - `auto_launch` boolean
    - `project_template_id` string, nullable
    - `finalized` boolean
    - `word_count_error` string, nullable
    - `cost_in_credits` number
    - `ctype` 'translation' | 'copywriting' | 'proofreading'
    - `creation_channel` string
    - `reference` string
    - `cost_per_word` object
      - `currency` string, required
      - `amount` number, required
    - `options` object
      - `language_level` 'enterprise' | 'regular' | 'premium'
    - `option_values` object
      - `language_level` 'enterprise' | 'regular' | 'premium'
    - `textmasters` string[]
    - `glossaries` string[]
    - `cost_in_currency` object
      - `currency` string, required
      - `amount` number, required
    - `api_template_id` string, nullable
    - `created_at` Date
      - `day` integer
      - `month` integer
      - `year` integer
      - `full` string
    - `updated_at` Date
      - `day` integer
      - `month` integer
      - `year` integer
      - `full` string
    - `launched_at` DateOrNull, nullable
      - `day` integer
      - `month` integer
      - `year` integer
      - `full` string
    - `completed_at` DateOrNull, nullable
      - `day` integer
      - `month` integer
      - `year` integer
      - `full` string
    - `work_template` WorkTemplate
      - `name` string, required
      - `description` string, nullable
      - `image_preview_path` string, nullable
      - `ctype` 'public' | 'private', required

## 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)