Skip to main content
GET
/
api
/
v1
/
document
List all documents
curl --request GET \
  --url https://in.rough.app/api/v1/document
[
  {
    "id": "<string>",
    "title": "<string>",
    "status": "CANCELED",
    "publicId": 123,
    "createdByUserId": "<string>",
    "ownedByTeamId": "<string>",
    "ownedByPersonId": "<string>",
    "vcsTagList": [
      "<string>"
    ],
    "archivedAt": 123,
    "archivedByUserId": "<string>",
    "lastModifiedAt": 123,
    "releasedAt": 123
  }
]

Query Parameters

​
includeArchived
default:false

Whether to include archived documents in the list. Defaults to false.

Available options:
true

Response

​
id
string
required

The unique identifier of the document

​
title
string
required

The title of the document

​
status
enum<string>
required

The status of the document

Available options:
CANCELED,
IDEA,
DEVELOPMENT,
RELEASED,
DRAFT,
INITIAL,
ARCHIVED
​
publicId
number
required

The public identifier of the document

​
createdByUserId
string
required

The unique identifier of the user who created the document

​
vcsTagList
string[]
required

The list of VCS tags associated with the document

​
lastModifiedAt
number
required

The timestamp when the document was last modified

​
ownedByTeamId
string

The unique identifier of the team that owns the document

​
ownedByPersonId
string

The unique identifier of the person that owns the document

​
archivedAt
number

The timestamp when the document was archived

​
archivedByUserId
string

The unique identifier of the user who archived the document

​
releasedAt
number

The timestamp when the document was released