Get document tree
GET /documents/tree
GET
/documents/tree
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” projectIdOrKey
required
string
Responses
Section titled “ Responses ”The request has succeeded.
Document tree response.
object
projectId
required
integer format: int64
activeTree
required
Document tree container (Active or Trash).
object
id
required
string
children
required
Array<object>
Document tree node.
object
id
required
string
name
required
string
emoji
required
string
children
required
Array<object> recursive
trashTree
required
Document tree container (Active or Trash).
object
id
required
string
children
required
Array<object>
Document tree node.
object
id
required
string
name
required
string
emoji
required
string
children
required
Array<object> recursive
default
Section titled “default ”An unexpected error response.
Error response wrapper returned by all Backlog API error responses.
object
errors
required
Array<object>
Individual error detail returned by the Backlog API.
object
message
required
Error message.
string
code
required
Error code.
- 1: InternalError
- 2: LicenceError
- 3: LicenceExpiredError
- 4: AccessDeniedError
- 5: UnauthorizedOperationError
- 6: NoResourceError
- 7: InvalidRequestError
- 8: SpaceOverCapacityError
- 9: ResourceOverflowError
- 10: TooLargeFileError
- 11: AuthenticationError
- 12: RequiredMFAError
- 13: TooManyRequestsError
integer format: int32
moreInfo
required
Additional information about the error.
string