---
agentTools:
  projectIndex: https://motaword.readme.io/llms.txt
---

# List projects

Get a list of your projects

Projects are the core of MotaWord API. Any time you create a new translation project, you will be getting a translation quote. You can add documents, style guides and glossaries to your project or update its language pairs before launching it; some actions such as modifying documents or language pairs will change the price of the project.

When you decide to launch a project, begin its translation, you need to issue a `launch` call. For details about launching and project payments, [see this section](http://motaword.readme.io/docs/start-a-project).

*Communicating context to translator is of utmost importance for a high-quality translation. Uploading files that assist translators with context such as style guides and glossaries are absolutely no-cost features and [we encourage you to use them](http://motaword.readme.io/docs/list-style-guides)!*

[block:api-header]
{
  "type": "basic",
  "title": "Project status"
}
[/block]

`status` field in project detail can be one of the followings:

* **pending:** The project is pending for payment, has not started yet. This is basically a quote at the moment.
* **started:** The project was launched and the translation has begun.
* **completed:** The project's translation and proofreading were completed and ready to be delivered.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.5.2"
  },
  "servers": [
    {
      "url": "https://api.motaword.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "access_token",
        "in": "query",
        "x-default": ""
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/projects": {
      "get": {
        "summary": "List projects",
        "description": "Get a list of your projects",
        "operationId": "list-projects",
        "parameters": [
          {
            "name": "per_page",
            "in": "query",
            "description": "Number of projects per page",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Current page",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\t\"projects\": [\n  \t{\n      \"id\": 1,\n      \"source_language\": \"string\",\n      \"target_languages\": [\n        \"string\"\n      ],\n      \"word_count\": 123,\n      \"price\": {\n      \t\"amount\": 1.00,\n        \"currency\": \"usd\"\n      },\n      \"status\": \"string\",\n      \"delivery_at\": 1553880303,\n      \"valid_until\": 1553880303,\n      \"callback_url\": \"string\",\n      \"custom\": {},\n      \"created_at\": 1553880303,\n      \"links\": {\n        \"self\": {\n          \"href\": \"https://api.motaword.com/v0/projects/1\"\n        },\n        \"documents\": {\n          \"href\": \"https://api.motaword.com/v0/projects/1/documents\"\n        },\n        \"styleguides\": {\n          \"href\": \"https://api.motaword.com/v0/projects/1/styleguides\"\n        },\n        \"glossaries\": {\n          \"href\": \"https://api.motaword.com/v0/projects/1/glossaries\"\n        }\n      }\n    }\n  ],\n  \"meta\": {\n    \"paging\": {\n      \"links\": {\n        \"next\": \"string\",\n        \"previous\": \"string\",\n        \"self\": \"string\"\n      },\n      \"page\": 1,\n      \"per_page\": 10,\n      \"total_count\": 12\n    }\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "projects": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "source_language": {
                            "type": "string",
                            "example": "string"
                          },
                          "target_languages": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": "string"
                            }
                          },
                          "word_count": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "price": {
                            "type": "object",
                            "properties": {
                              "amount": {
                                "type": "integer",
                                "example": 1,
                                "default": 0
                              },
                              "currency": {
                                "type": "string",
                                "example": "usd"
                              }
                            }
                          },
                          "status": {
                            "type": "string",
                            "example": "string"
                          },
                          "delivery_at": {
                            "type": "integer",
                            "example": 1553880303,
                            "default": 0
                          },
                          "valid_until": {
                            "type": "integer",
                            "example": 1553880303,
                            "default": 0
                          },
                          "callback_url": {
                            "type": "string",
                            "example": "string"
                          },
                          "custom": {
                            "type": "object",
                            "properties": {}
                          },
                          "created_at": {
                            "type": "integer",
                            "example": 1553880303,
                            "default": 0
                          },
                          "links": {
                            "type": "object",
                            "properties": {
                              "self": {
                                "type": "object",
                                "properties": {
                                  "href": {
                                    "type": "string",
                                    "example": "https://api.motaword.com/v0/projects/1"
                                  }
                                }
                              },
                              "documents": {
                                "type": "object",
                                "properties": {
                                  "href": {
                                    "type": "string",
                                    "example": "https://api.motaword.com/v0/projects/1/documents"
                                  }
                                }
                              },
                              "styleguides": {
                                "type": "object",
                                "properties": {
                                  "href": {
                                    "type": "string",
                                    "example": "https://api.motaword.com/v0/projects/1/styleguides"
                                  }
                                }
                              },
                              "glossaries": {
                                "type": "object",
                                "properties": {
                                  "href": {
                                    "type": "string",
                                    "example": "https://api.motaword.com/v0/projects/1/glossaries"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "paging": {
                          "type": "object",
                          "properties": {
                            "links": {
                              "type": "object",
                              "properties": {
                                "next": {
                                  "type": "string",
                                  "example": "string"
                                },
                                "previous": {
                                  "type": "string",
                                  "example": "string"
                                },
                                "self": {
                                  "type": "string",
                                  "example": "string"
                                }
                              }
                            },
                            "page": {
                              "type": "integer",
                              "example": 1,
                              "default": 0
                            },
                            "per_page": {
                              "type": "integer",
                              "example": 10,
                              "default": 0
                            },
                            "total_count": {
                              "type": "integer",
                              "example": 12,
                              "default": 0
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"error\": {\n        \"code\": \"InvalidApiClient\",\n        \"http_code\": 401,\n        \"message\": \"Your access token is wrong.\",\n        \"help\": \"https://www.motaword.com/developer/support\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "object",
                      "properties": {
                        "code": {
                          "type": "string",
                          "example": "InvalidApiClient"
                        },
                        "http_code": {
                          "type": "integer",
                          "example": 401,
                          "default": 0
                        },
                        "message": {
                          "type": "string",
                          "example": "Your access token is wrong."
                        },
                        "help": {
                          "type": "string",
                          "example": "https://www.motaword.com/developer/support"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6305402c9807941f67a92eb7:551ffc8e9aa80d0d00e17789"
}
```