Skip to main content
GET
Get Tree Document At Commit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_id
string<uuid>
required
node_id
string
required
branch
string
required
commit_id
string
required

Response

Successful Response

GET /tree/{branch}. Valid input to PUT /tree/{branch}/push as returned: edit state, set message, send it back. expected_head_commit is the branch head this document was read at; a stale one is rejected with 409.

Read at a commit (GET .../commits/{commit_id}/tree) the document is read-only: it has no expected_head_commit, so push rejects it (422).

state
NodeState · object
required

The five sections push stores. Push replaces all of them: an omitted section is stored as empty.

status
TreeStatus · object
required

Read-only context. Push ignores it.

expected_head_commit
string | null

Branch head this document was read at. Absent when read at a commit: that document is read-only.

message
string
default:""

Commit message; empty until you set one