Heartwork API

Comments

Endpointhttps://api.heart.work

Download schema

Gets comments based on specific property values.

GET

https://api.heart.work

/core-api/comments

Gets comments based on specific property values. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

CreatedAt

Query

string

entity_ids

string[]

created_at.Min

string · date-time

created_at.Max

string · date-time

ids

string[]

external_references

string[]

Gets comments based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/comments

curl --request GET \
  --url https://api.heart.work/core-api/comments

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "body": "body",
      "bodyFormat": "Text",
      "createdBy": {
        "id": "id",
        "name": "name",
        "type": "HeartworkUser"
      },
      "isEdited": true
    }
  ],
  "total": 0
}

plain

Creates and stores a new comment.

POST

https://api.heart.work

/core-api/comments

On success, returns the newly created entity in the response.

Creates and stores a new comment. › Request Body

entityId

string · required

entityType

string · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

Creates and stores a new comment. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

object · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

object · required

isEdited

boolean · readOnly · required

externalReference

string

POST/core-api/comments

curl --request POST \
  --url https://api.heart.work/core-api/comments \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "entityId",
  "entityType": "entityType",
  "body": "body",
  "bodyFormat": "Text"
}
'

shell

Example Request Body

{
  "entityId": "entityId",
  "entityType": "entityType",
  "body": "body",
  "bodyFormat": "Text"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "entity": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "body": "body",
  "bodyFormat": "Text",
  "createdBy": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "isEdited": true
}

plain

Updates an existing comment, replacing it entirely.

PUT

https://api.heart.work

/core-api/comments/{id}

On success, returns the updated entity in the response.

Updates an existing comment, replacing it entirely. › path Parameters

id

string · required

Updates an existing comment, replacing it entirely. › Request Body

id

string · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

Updates an existing comment, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

object · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

object · required

isEdited

boolean · readOnly · required

externalReference

string

PUT/core-api/comments/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/comments/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "body": "body",
  "bodyFormat": "Text"
}
'

shell

Example Request Body

{
  "id": "id",
  "body": "body",
  "bodyFormat": "Text"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "entity": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "body": "body",
  "bodyFormat": "Text",
  "createdBy": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "isEdited": true
}

plain

Deletes an existing comment, by id.

DELETE

https://api.heart.work

/core-api/comments/{id}

Deletes an existing comment, by id. › path Parameters

id

string · required

Unique id of the comment to delete.

Deletes an existing comment, by id. › Responses

No data returned

DELETE/core-api/comments/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/comments/:id

shell

Example Responses

No example specified for this content type

Catalogs Contacts

Heartwork API

Comments

Endpointhttps://api.heart.work

Download schema

Gets comments based on specific property values.

GET

https://api.heart.work

/core-api/comments

Gets comments based on specific property values. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

CreatedAt

Query

string

entity_ids

string[]

created_at.Min

string · date-time

created_at.Max

string · date-time

ids

string[]

external_references

string[]

Gets comments based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/comments

curl --request GET \
  --url https://api.heart.work/core-api/comments

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "body": "body",
      "bodyFormat": "Text",
      "createdBy": {
        "id": "id",
        "name": "name",
        "type": "HeartworkUser"
      },
      "isEdited": true
    }
  ],
  "total": 0
}

plain

Creates and stores a new comment.

POST

https://api.heart.work

/core-api/comments

On success, returns the newly created entity in the response.

Creates and stores a new comment. › Request Body

entityId

string · required

entityType

string · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

Creates and stores a new comment. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

object · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

object · required

isEdited

boolean · readOnly · required

externalReference

string

POST/core-api/comments

curl --request POST \
  --url https://api.heart.work/core-api/comments \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "entityId",
  "entityType": "entityType",
  "body": "body",
  "bodyFormat": "Text"
}
'

shell

Example Request Body

{
  "entityId": "entityId",
  "entityType": "entityType",
  "body": "body",
  "bodyFormat": "Text"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "entity": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "body": "body",
  "bodyFormat": "Text",
  "createdBy": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "isEdited": true
}

plain

Updates an existing comment, replacing it entirely.

PUT

https://api.heart.work

/core-api/comments/{id}

On success, returns the updated entity in the response.

Updates an existing comment, replacing it entirely. › path Parameters

id

string · required

Updates an existing comment, replacing it entirely. › Request Body

id

string · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

Updates an existing comment, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

object · required

body

string · required

bodyFormat

string · enum · required

Enum values:

Text

Json

Markdown

object · required

isEdited

boolean · readOnly · required

externalReference

string

PUT/core-api/comments/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/comments/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id",
  "body": "body",
  "bodyFormat": "Text"
}
'

shell

Example Request Body

{
  "id": "id",
  "body": "body",
  "bodyFormat": "Text"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "entity": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "body": "body",
  "bodyFormat": "Text",
  "createdBy": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "isEdited": true
}

plain

Deletes an existing comment, by id.

DELETE

https://api.heart.work

/core-api/comments/{id}

Deletes an existing comment, by id. › path Parameters

id

string · required

Unique id of the comment to delete.

Deletes an existing comment, by id. › Responses

No data returned

DELETE/core-api/comments/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/comments/:id

shell

Example Responses

No example specified for this content type

Catalogs Contacts