Get document list

Returns list of Document pages.

Role

All

Method

GET

URL

/api/v2/documents

Query parameters

Parameter Name	Type	Description
projectId[] (Multiple)	Number	Project ID
keyword	String	Keyword
sort	String	created updated
order	String	Order of the sort “asc” or “desc” default=“desc”
offset	Int
count	Int	number of records to retrieve(1-100) default=20

Response example

Response Body

[
  {
    "id": "01939983409c79d5a06a49859789e38f",
    "projectId": 1,
    "title": "Hello",
    "plain": "hello",
    "json": "{}",
    "statusId": 1,
    "emoji": "\uD83C\uDF89",
    "attachments": [
      {
        "id": 22067,
        "name": "test.png",
        "size": 8718,
        "createdUser": {
          "id": 3,
          "userId": "woody",
          "name": "woody",
          "roleType": 2,
          "lang": "ja",
          "mailAddress": "woody@nulab.com",
          "nulabAccount": {
            "nulabId": "aaa",
            "name": "woody",
            "uniqueId": "woody",
            "iconUrl": "https://photo"
          },
          "keyword": "woody",
          "lastLoginTime": "2025-05-22T23:04:03Z"
          },
          "created": "2025-05-29T02:19:54Z"
        }
    ],
    "tags": [
      {
        "id": 1,
        "name": "Backlog"
      }
    ],
    "createdUser": {
      "id": 2,
      "userId": "woody",
      "name": "woody",
      "roleType": 1,
      "lang": "en",
      "mailAddress": "woody@nulab.com",
      "nulabAccount": null,
      "keyword": "Woody",
      "lastLoginTime": "2025-05-28T22:24:36Z"
    },
    "created": "2024-12-06T01:08:56Z",
    "updatedUser": {
      "id": 2,
      "userId": "woody",
      "name": "woody",
      "roleType": 1,
      "lang": "en",
      "mailAddress": "uchida@nulab.com",
      "nulabAccount": null,
      "keyword": "Woody",
      "lastLoginTime": "2025-05-28T22:24:36Z"
    },
    "updated": "2025-04-28T01:47:02Z"
  },
  {
    "id": "0193b335c62173de9547bab5dd0b5324",
    "projectId": 1,
    "title": "top",
    "plain": "hello",
    "json": "{}",
    "statusId": 1,
    "emoji": null,
    "attachments": [],
    "tags": [],
    "createdUser": {
      "id": 2,
      "userId": "woody",
      "name": "woody",
      "roleType": 1,
      "lang": "en",
      "mailAddress": "woody@nulab.com",
      "nulabAccount": null,
      "keyword": "Woody",
      "lastLoginTime": "2025-05-28T22:24:36Z"
    },
    "created": "2024-12-06T01:08:56Z",
    "updatedUser": {
      "id": 2,
      "userId": "woody",
      "name": "woody",
      "roleType": 1,
      "lang": "en",
      "mailAddress": "woody@nulab.com",
      "nulabAccount": null,
      "keyword": "Woody",
      "lastLoginTime": "2025-05-28T22:24:36Z"
    },
    "updated": "2025-04-28T01:47:02Z"
  }
  // ...
]