Skip to main content
GET
/
clause-reference
/
get-clause
/
{clauseReferenceId}
Retrieve a clause block
curl --request GET \
  --url https://app.myhero.so/clause-reference/get-clause/{clauseReferenceId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "clauseBlockResults": [
      {
        "_id": "<string>",
        "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
    }
  }
}

Authorizations

Authorization
string
header
required

HERO personal access token

Path Parameters

clauseReferenceId
string
required
Minimum string length: 1

Response

200 response

data
object
required