Heartwork API

Deals

Endpointhttps://api.heart.work

Download schema

Fetches a collection of deals, for the provided workspace based on optional filters

GET

https://api.heart.work

/core-api/deals

Fetches a collection of deals, for the provided workspace based on optional filters › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

CreatedAt

Title

ExpectedRevenue

SuccessRate

ModifiedAt

Query

string

ids

string[]

external_references

string[]

expected_revenue.Min

number · double

expected_revenue.Max

number · double

owner_ids

string[]

account_ids

string[]

pipeline_ids

string[]

status_ids

string[]

archived

boolean

Fetches a collection of deals, for the provided workspace based on optional filters › Responses

object[] · required

total

integer · int32 · required

GET/core-api/deals

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "title": "title",
      "description": "description",
      "expectedRevenue": 0,
      "owner": {
        "id": "id",
        "name": "name",
        "type": "HeartworkUser"
      },
      "account": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "successRate": 0,
      "startDate": "2024-08-25T15:00:00Z",
      "endDate": "2024-08-25T15:00:00Z",
      "pipeline": {
        "id": "id",
        "name": "name",
        "type": "Pipeline"
      },
      "pipelineOptionValues": [
        {
          "pipelineOptionId": "pipelineOptionId",
          "value": 0
        }
      ],
      "statusId": "statusId",
      "statusModifiedAt": "2024-08-25T15:00:00Z",
      "archived": true,
      "connections": [
        {
          "label": "label",
          "reverseLabel": "reverseLabel",
          "type": "type",
          "entity": {
            "id": "id",
            "name": "name",
            "type": "Account"
          }
        }
      ],
      "tags": [
        "string"
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new deal.

POST

https://api.heart.work

/core-api/deals

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

Creates and stores a new deal. › Request Body

title

string · required

expectedRevenue

number · double · required

pipelineId

string · required

statusId

string · required

externalReference

string

description

string

ownerId

string

accountId

string

successRate

integer · int32

startDate

string · date-time

endDate

string · date-time

object[]

tags

string[]

Creates and stores a new deal. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

expectedRevenue

number · double · required

object · required

object[] · required

statusId

string · required

statusModifiedAt

string · date-time · required

archived

boolean · required

object[] · required

tags

string[] · required

externalReference

string

description

string

object

successRate

integer · int32

startDate

string · date-time

endDate

string · date-time

POST/core-api/deals

curl --request POST \
  --url https://api.heart.work/core-api/deals \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "ownerId": "ownerId",
  "accountId": "accountId",
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipelineId": "pipelineId",
  "statusId": "statusId",
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "tags": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "ownerId": "ownerId",
  "accountId": "accountId",
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipelineId": "pipelineId",
  "statusId": "statusId",
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "account": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipeline": {
    "id": "id",
    "name": "name",
    "type": "Pipeline"
  },
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "statusId": "statusId",
  "statusModifiedAt": "2024-08-25T15:00:00Z",
  "archived": true,
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "tags": [
    "string"
  ]
}

plain

Fetches a single deal, by id.

GET

https://api.heart.work

/core-api/deals/{id}

Fetches a single deal, by id. › path Parameters

id

string · required

Unique id of the deal to fetch.

Fetches a single deal, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

expectedRevenue

number · double · required

object · required

object[] · required

statusId

string · required

statusModifiedAt

string · date-time · required

archived

boolean · required

object[] · required

tags

string[] · required

externalReference

string

description

string

object

successRate

integer · int32

startDate

string · date-time

endDate

string · date-time

GET/core-api/deals/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "account": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipeline": {
    "id": "id",
    "name": "name",
    "type": "Pipeline"
  },
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "statusId": "statusId",
  "statusModifiedAt": "2024-08-25T15:00:00Z",
  "archived": true,
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "tags": [
    "string"
  ]
}

plain

Updates an existing deal, replacing it entirely.

PUT

https://api.heart.work

/core-api/deals/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

title

string · required

expectedRevenue

number · double · required

pipelineId

string · required

statusId

string · required

id

string · required

externalReference

string

description

string

ownerId

string

accountId

string

successRate

integer · int32

startDate

string · date-time

endDate

string · date-time

object[]

tags

string[]

Updates an existing deal, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

expectedRevenue

number · double · required

object · required

object[] · required

statusId

string · required

statusModifiedAt

string · date-time · required

archived

boolean · required

object[] · required

tags

string[] · required

externalReference

string

description

string

object

successRate

integer · int32

startDate

string · date-time

endDate

string · date-time

PUT/core-api/deals/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/deals/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "ownerId": "ownerId",
  "accountId": "accountId",
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipelineId": "pipelineId",
  "statusId": "statusId",
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "tags": [
    "string"
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "ownerId": "ownerId",
  "accountId": "accountId",
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipelineId": "pipelineId",
  "statusId": "statusId",
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "tags": [
    "string"
  ],
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "account": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipeline": {
    "id": "id",
    "name": "name",
    "type": "Pipeline"
  },
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "statusId": "statusId",
  "statusModifiedAt": "2024-08-25T15:00:00Z",
  "archived": true,
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "tags": [
    "string"
  ]
}

plain

Deletes an existing deal, by id.

DELETE

https://api.heart.work

/core-api/deals/{id}

Deletes an existing deal, by id. › path Parameters

id

string · required

Unique id of the deal to delete.

Deletes an existing deal, by id. › Responses

No data returned

DELETE/core-api/deals/{id}

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

shell

Example Responses

No example specified for this content type

Get all filterable values for deals

GET

https://api.heart.work

/core-api/deals/filters

Get all filterable values for deals › query Parameters

pipelineId

string

Get all filterable values for deals › Responses

object · required

object[] · required

tags

string[] · required

object[] · required

GET/core-api/deals/filters

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

shell

Example Responses

{
  "revenueRange": {
    "min": 0,
    "max": 0
  },
  "connections": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "owners": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "statuses": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "accounts": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Archive an existing deal, by id.

PUT

https://api.heart.work

/core-api/deals/{id}/archive

Archive an existing deal, by id. › path Parameters

id

string · required

Unique id of the deal to archive.

Archive an existing deal, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

expectedRevenue

number · double · required

object · required

object[] · required

statusId

string · required

statusModifiedAt

string · date-time · required

archived

boolean · required

object[] · required

tags

string[] · required

externalReference

string

description

string

object

successRate

integer · int32

startDate

string · date-time

endDate

string · date-time

PUT/core-api/deals/{id}/archive

curl --request PUT \
  --url https://api.heart.work/core-api/deals/:id/archive

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "account": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipeline": {
    "id": "id",
    "name": "name",
    "type": "Pipeline"
  },
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "statusId": "statusId",
  "statusModifiedAt": "2024-08-25T15:00:00Z",
  "archived": true,
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "tags": [
    "string"
  ]
}

plain

Restore an existing deal, by id.

PUT

https://api.heart.work

/core-api/deals/{id}/restore

Restore an existing deal, by id. › path Parameters

id

string · required

Unique id of the deal to unarchive.

Restore an existing deal, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

expectedRevenue

number · double · required

object · required

object[] · required

statusId

string · required

statusModifiedAt

string · date-time · required

archived

boolean · required

object[] · required

tags

string[] · required

externalReference

string

description

string

object

successRate

integer · int32

startDate

string · date-time

endDate

string · date-time

PUT/core-api/deals/{id}/restore

curl --request PUT \
  --url https://api.heart.work/core-api/deals/:id/restore

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "expectedRevenue": 0,
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "account": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "successRate": 0,
  "startDate": "2024-08-25T15:00:00Z",
  "endDate": "2024-08-25T15:00:00Z",
  "pipeline": {
    "id": "id",
    "name": "name",
    "type": "Pipeline"
  },
  "pipelineOptionValues": [
    {
      "pipelineOptionId": "pipelineOptionId",
      "value": 0
    }
  ],
  "statusId": "statusId",
  "statusModifiedAt": "2024-08-25T15:00:00Z",
  "archived": true,
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "tags": [
    "string"
  ]
}

plain

Fetches all used deals unique statuses

GET

https://api.heart.work

/core-api/masterdata/deals/statuses

Fetches all used deals unique statuses › Responses

object[]

id

string · required

name

string · required

displayOrder

integer · int32 · required

GET/core-api/masterdata/deals/statuses

curl --request GET \
  --url https://api.heart.work/core-api/masterdata/deals/statuses

shell

Example Responses

[
  {
    "id": "id",
    "name": "name",
    "displayOrder": 0
  }
]

plain

Fetches all used contact unique tags

GET

https://api.heart.work

/core-api/masterdata/deals/tags

Fetches all used contact unique tags › Responses

string[]

GET/core-api/masterdata/deals/tags

curl --request GET \
  --url https://api.heart.work/core-api/masterdata/deals/tags

shell

Example Responses

[
  "string"
]

plain

Currencies DealStatistics