Heartwork API

Activities

Endpointhttps://api.heart.work

Download schema

Fetches a filtered collection of heartwork activities, for the provided workspace.

GET

https://api.heart.work

/core-api/activities

Fetches a filtered collection of heartwork activities, for the provided workspace. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Timestamp

entity_ids

string[]

timestamp.Min

string · date-time

timestamp.Max

string · date-time

types

string[]

Enum values:

AccountAccountCodeUpdated

AccountAccountStatusUpdated

AccountAccountTypeUpdated

AccountAttributesUpdated

AccountBillingAddressUpdated

AccountChamberOfCommerceRubricationCodesUpdated

AccountChamberOfCommerceUpdated

AccountCommerceSettingsUpdated

Fetches a filtered collection of heartwork activities, for the provided workspace. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/activities

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "timestamp": "2024-08-25T15:00:00Z",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "type": "type",
      "user": {
        "id": "id",
        "name": "name"
      },
      "workspace": "workspace"
    }
  ],
  "total": 0
}

plain

An exception to the normal List method for when the url becomes too long

POST

https://api.heart.work

/core-api/activities/filter

An exception to the normal List method for when the url becomes too long › Request Body

take

integer · int32 · required

skip

integer · int32 · required

sortBy

string · enum · required

Enum values:

Timestamp

sortOrder

string · enum

Enum values:

Asc

Desc

entityIds

string[]

object

types

string[]

Enum values:

AccountAccountCodeUpdated

AccountAccountStatusUpdated

AccountAccountTypeUpdated

AccountAttributesUpdated

AccountBillingAddressUpdated

AccountChamberOfCommerceRubricationCodesUpdated

AccountChamberOfCommerceUpdated

AccountCommerceSettingsUpdated

An exception to the normal List method for when the url becomes too long › Responses

object[] · required

total

integer · int32 · required

POST/core-api/activities/filter

curl --request POST \
  --url https://api.heart.work/core-api/activities/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "Timestamp",
  "entityIds": [
    "string"
  ],
  "timestamp": {
    "min": "2024-08-25T15:00:00Z",
    "max": "2024-08-25T15:00:00Z"
  },
  "types": [
    "AccountAccountCodeUpdated"
  ]
}
'

shell

Example Request Body

{
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "Timestamp",
  "entityIds": [
    "string"
  ],
  "timestamp": {
    "min": "2024-08-25T15:00:00Z",
    "max": "2024-08-25T15:00:00Z"
  },
  "types": [
    "AccountAccountCodeUpdated"
  ]
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "timestamp": "2024-08-25T15:00:00Z",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "type": "type",
      "user": {
        "id": "id",
        "name": "name"
      },
      "workspace": "workspace"
    }
  ],
  "total": 0
}

plain

Accounts ActivityStatistics

Heartwork API

Activities

Endpointhttps://api.heart.work

Download schema

Fetches a filtered collection of heartwork activities, for the provided workspace.

GET

https://api.heart.work

/core-api/activities

Fetches a filtered collection of heartwork activities, for the provided workspace. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Timestamp

entity_ids

string[]

timestamp.Min

string · date-time

timestamp.Max

string · date-time

types

string[]

Enum values:

AccountAccountCodeUpdated

AccountAccountStatusUpdated

AccountAccountTypeUpdated

AccountAttributesUpdated

AccountBillingAddressUpdated

AccountChamberOfCommerceRubricationCodesUpdated

AccountChamberOfCommerceUpdated

AccountCommerceSettingsUpdated

Fetches a filtered collection of heartwork activities, for the provided workspace. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/activities

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "timestamp": "2024-08-25T15:00:00Z",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "type": "type",
      "user": {
        "id": "id",
        "name": "name"
      },
      "workspace": "workspace"
    }
  ],
  "total": 0
}

plain

An exception to the normal List method for when the url becomes too long

POST

https://api.heart.work

/core-api/activities/filter

An exception to the normal List method for when the url becomes too long › Request Body

take

integer · int32 · required

skip

integer · int32 · required

sortBy

string · enum · required

Enum values:

Timestamp

sortOrder

string · enum

Enum values:

Asc

Desc

entityIds

string[]

object

types

string[]

Enum values:

AccountAccountCodeUpdated

AccountAccountStatusUpdated

AccountAccountTypeUpdated

AccountAttributesUpdated

AccountBillingAddressUpdated

AccountChamberOfCommerceRubricationCodesUpdated

AccountChamberOfCommerceUpdated

AccountCommerceSettingsUpdated

An exception to the normal List method for when the url becomes too long › Responses

object[] · required

total

integer · int32 · required

POST/core-api/activities/filter

curl --request POST \
  --url https://api.heart.work/core-api/activities/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "Timestamp",
  "entityIds": [
    "string"
  ],
  "timestamp": {
    "min": "2024-08-25T15:00:00Z",
    "max": "2024-08-25T15:00:00Z"
  },
  "types": [
    "AccountAccountCodeUpdated"
  ]
}
'

shell

Example Request Body

{
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "Timestamp",
  "entityIds": [
    "string"
  ],
  "timestamp": {
    "min": "2024-08-25T15:00:00Z",
    "max": "2024-08-25T15:00:00Z"
  },
  "types": [
    "AccountAccountCodeUpdated"
  ]
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "timestamp": "2024-08-25T15:00:00Z",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "type": "type",
      "user": {
        "id": "id",
        "name": "name"
      },
      "workspace": "workspace"
    }
  ],
  "total": 0
}

plain

Accounts ActivityStatistics