Heartwork API

Documents

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/documents/structure

query Parameters

Query

string

AttachedTo

string

AttachedToType

string · enum

Enum values:

Account

Contact

Responses

object[] · required

total

integer · int32 · required

GET/core-api/documents/structure

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

shell

Example Responses

{
  "data": [
    {
      "name": "name",
      "path": "path"
    }
  ],
  "total": 0
}

plain

GET

https://api.heart.work

/core-api/documents

query Parameters

Name

string · required

Path

string

AttachedTo

string

AttachedToType

string · enum

Enum values:

Account

Contact

Responses

name

string · required

path

string · required

url

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

fileSize

integer · int64 · required

contentType

string · required

object · required

GET/core-api/documents

curl --request GET \
  --url 'https://api.heart.work/core-api/documents?Name=%3Cstring%3E'

shell

Example Responses

{
  "name": "name",
  "path": "path",
  "url": "url",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "fileSize": 0,
  "contentType": "contentType",
  "attachedTo": {
    "id": "id",
    "name": "name",
    "type": "Account"
  }
}

plain

POST

https://api.heart.work

/core-api/documents

query Parameters

AttachTo

string

AttachToType

string · enum

Enum values:

Account

Contact

Overwrite

boolean

Request Body

Files

string[] · required

Path

string

Responses

No data returned

POST/core-api/documents

curl --request POST \
  --url https://api.heart.work/core-api/documents \
  --header 'Content-Type: multipart/form-data' \
  --form Path=Path \
  --form Files=string

shell

Example Request Body

{
  "Path": "Path",
  "Files": [
    "string"
  ]
}

json

Example Responses

No example specified for this content type

DELETE

https://api.heart.work

/core-api/documents

Request Body

path

string · required

name

string · required

attachedTo

string

attachedToType

string · enum

Enum values:

Account

Contact

Responses

No data returned

DELETE/core-api/documents

curl --request DELETE \
  --url https://api.heart.work/core-api/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account"
}
'

shell

Example Request Body

{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account"
}

json

Example Responses

No example specified for this content type

POST

https://api.heart.work

/core-api/documents/directories

Request Body

name

string · required

path

string

attachTo

string

attachToType

string · enum

Enum values:

Account

Contact

Responses

No data returned

POST/core-api/documents/directories

curl --request POST \
  --url https://api.heart.work/core-api/documents/directories \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "path",
  "name": "name",
  "attachTo": "attachTo",
  "attachToType": "Account"
}
'

shell

Example Request Body

{
  "path": "path",
  "name": "name",
  "attachTo": "attachTo",
  "attachToType": "Account"
}

json

Example Responses

No example specified for this content type

DELETE

https://api.heart.work

/core-api/documents/directories

Request Body

name

string · required

recursive

boolean · required

path

string

attachedTo

string

attachedToType

string · enum

Enum values:

Account

Contact

Responses

No data returned

DELETE/core-api/documents/directories

curl --request DELETE \
  --url https://api.heart.work/core-api/documents/directories \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account",
  "recursive": true
}
'

shell

Example Request Body

{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account",
  "recursive": true
}

json

Example Responses

No example specified for this content type

DealStatistics FavouriteProducts

Heartwork API

Documents

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/documents/structure

query Parameters

Query

string

AttachedTo

string

AttachedToType

string · enum

Enum values:

Account

Contact

Responses

object[] · required

total

integer · int32 · required

GET/core-api/documents/structure

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

shell

Example Responses

{
  "data": [
    {
      "name": "name",
      "path": "path"
    }
  ],
  "total": 0
}

plain

GET

https://api.heart.work

/core-api/documents

query Parameters

Name

string · required

Path

string

AttachedTo

string

AttachedToType

string · enum

Enum values:

Account

Contact

Responses

name

string · required

path

string · required

url

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

fileSize

integer · int64 · required

contentType

string · required

object · required

GET/core-api/documents

curl --request GET \
  --url 'https://api.heart.work/core-api/documents?Name=%3Cstring%3E'

shell

Example Responses

{
  "name": "name",
  "path": "path",
  "url": "url",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "fileSize": 0,
  "contentType": "contentType",
  "attachedTo": {
    "id": "id",
    "name": "name",
    "type": "Account"
  }
}

plain

POST

https://api.heart.work

/core-api/documents

query Parameters

AttachTo

string

AttachToType

string · enum

Enum values:

Account

Contact

Overwrite

boolean

Request Body

Files

string[] · required

Path

string

Responses

No data returned

POST/core-api/documents

curl --request POST \
  --url https://api.heart.work/core-api/documents \
  --header 'Content-Type: multipart/form-data' \
  --form Path=Path \
  --form Files=string

shell

Example Request Body

{
  "Path": "Path",
  "Files": [
    "string"
  ]
}

json

Example Responses

No example specified for this content type

DELETE

https://api.heart.work

/core-api/documents

Request Body

path

string · required

name

string · required

attachedTo

string

attachedToType

string · enum

Enum values:

Account

Contact

Responses

No data returned

DELETE/core-api/documents

curl --request DELETE \
  --url https://api.heart.work/core-api/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account"
}
'

shell

Example Request Body

{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account"
}

json

Example Responses

No example specified for this content type

POST

https://api.heart.work

/core-api/documents/directories

Request Body

name

string · required

path

string

attachTo

string

attachToType

string · enum

Enum values:

Account

Contact

Responses

No data returned

POST/core-api/documents/directories

curl --request POST \
  --url https://api.heart.work/core-api/documents/directories \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "path",
  "name": "name",
  "attachTo": "attachTo",
  "attachToType": "Account"
}
'

shell

Example Request Body

{
  "path": "path",
  "name": "name",
  "attachTo": "attachTo",
  "attachToType": "Account"
}

json

Example Responses

No example specified for this content type

DELETE

https://api.heart.work

/core-api/documents/directories

Request Body

name

string · required

recursive

boolean · required

path

string

attachedTo

string

attachedToType

string · enum

Enum values:

Account

Contact

Responses

No data returned

DELETE/core-api/documents/directories

curl --request DELETE \
  --url https://api.heart.work/core-api/documents/directories \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account",
  "recursive": true
}
'

shell

Example Request Body

{
  "path": "path",
  "name": "name",
  "attachedTo": "attachedTo",
  "attachedToType": "Account",
  "recursive": true
}

json

Example Responses

No example specified for this content type

DealStatistics FavouriteProducts