Skip to main content
GET
/
block
/
get-clause
/
{clauseReferenceId}
Retrieve a clause block
curl --request GET \
  --url https://app.myhero.so/block/get-clause/{clauseReferenceId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "clauseBlockResults": [
      {
        "_id": "<string>",
        "type": "clauseBlock",
        "properties": {
          "attributes": {},
          "content": [
            {
              "id": "<string>",
              "type": "<string>",
              "text": "<string>",
              "marks": [
                {
                  "type": "<string>",
                  "attributes": {}
                }
              ]
            }
          ],
          "marks": [
            {
              "type": "<string>",
              "attributes": {}
            }
          ]
        },
        "nodeId": "<string>",
        "userId": "<string>",
        "projectId": "<string>",
        "workspaceId": "<string>",
        "createdAt": 123,
        "updatedAt": 123,
        "originId": "<string>",
        "parentId": "<string>",
        "isDeleted": false
      }
    ],
    "clauseReferenceRecord": {
      "_id": "<string>",
      "blockId": "<string>",
      "documentId": "<string>",
      "workspaceId": "<string>",
      "hierarchy": "<string>",
      "createdAt": 123,
      "updatedAt": 123,
      "originId": "<string>",
      "isDeleted": false
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.myhero.so/llms.txt

Use this file to discover all available pages before exploring further.

Looks up the clause block associated with a clause reference, first by block ID and then by the reference’s hierarchy string. Returns the clauseBlockResults array and the clauseReferenceRecord. Responds with HTTP 404 when the block is not found but still includes a placeholder entry with isNotFound: true.

Authorizations

Authorization
string
header
required

HERO personal access token

Path Parameters

clauseReferenceId
string
required
Minimum string length: 1

Response

200 response

data
object
required