Heartwork API

Contacts

Endpointhttps://api.heart.work

Download schema

Fetches a single contact, by id.

GET

https://api.heart.work

/core-api/contacts/{id}

Fetches a single contact, by id. › path Parameters

id

string · required

Unique id of the contact to fetch.

Fetches a single contact, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

firstName

string · required

lastName

string · required

displayName

string · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

tags

string[] · required

externalReference

string

middleName

string

description

string

dateOfBirth

string · date-time

gender

string

title

string

jobTitle

string

notes

string

ownerId

string

clientLoginId

string

interestsAndHobbies

string

lastContactMoment

string · date-time

salesOrderProcessorId

string

object

GET/core-api/contacts/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "firstName": "firstName",
  "lastName": "lastName",
  "displayName": "displayName",
  "middleName": "middleName",
  "description": "description",
  "dateOfBirth": "2024-08-25T15:00:00Z",
  "gender": "gender",
  "title": "title",
  "jobTitle": "jobTitle",
  "notes": "notes",
  "ownerId": "ownerId",
  "clientLoginId": "clientLoginId",
  "interestsAndHobbies": "interestsAndHobbies",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "displayOrder": 0,
  "salesOrderProcessorId": "salesOrderProcessorId",
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    }
  },
  "attributes": {},
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "salesOrderProcessor": {
    "id": "id",
    "name": "name",
    "type": "Location"
  },
  "clientLogin": {
    "id": "id",
    "name": "name",
    "type": "ClientLogin"
  }
}

plain

Updates an existing contact, replacing it entirely.

PUT

https://api.heart.work

/core-api/contacts/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

firstName

string · required

lastName

string · required

displayOrder

integer · int32 · required

id

string · required

externalReference

string

middleName

string

description

string

dateOfBirth

string · date-time

gender

string

title

string

jobTitle

string

notes

string

ownerId

string

clientLoginId

string

interestsAndHobbies

string

object[]

lastContactMoment

string · date-time

salesOrderProcessorId

string

object

object[]

tags

string[]

Updates an existing contact, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

firstName

string · required

lastName

string · required

displayName

string · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

tags

string[] · required

externalReference

string

middleName

string

description

string

dateOfBirth

string · date-time

gender

string

title

string

jobTitle

string

notes

string

ownerId

string

clientLoginId

string

interestsAndHobbies

string

lastContactMoment

string · date-time

salesOrderProcessorId

string

object

PUT/core-api/contacts/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/contacts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "firstName": "firstName",
  "lastName": "lastName",
  "middleName": "middleName",
  "description": "description",
  "dateOfBirth": "2024-08-25T15:00:00Z",
  "gender": "gender",
  "title": "title",
  "jobTitle": "jobTitle",
  "notes": "notes",
  "ownerId": "ownerId",
  "clientLoginId": "clientLoginId",
  "interestsAndHobbies": "interestsAndHobbies",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "displayOrder": 0,
  "salesOrderProcessorId": "salesOrderProcessorId",
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    }
  },
  "attributes": {},
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "firstName": "firstName",
  "lastName": "lastName",
  "middleName": "middleName",
  "description": "description",
  "dateOfBirth": "2024-08-25T15:00:00Z",
  "gender": "gender",
  "title": "title",
  "jobTitle": "jobTitle",
  "notes": "notes",
  "ownerId": "ownerId",
  "clientLoginId": "clientLoginId",
  "interestsAndHobbies": "interestsAndHobbies",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "displayOrder": 0,
  "salesOrderProcessorId": "salesOrderProcessorId",
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    }
  },
  "attributes": {},
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "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",
  "firstName": "firstName",
  "lastName": "lastName",
  "displayName": "displayName",
  "middleName": "middleName",
  "description": "description",
  "dateOfBirth": "2024-08-25T15:00:00Z",
  "gender": "gender",
  "title": "title",
  "jobTitle": "jobTitle",
  "notes": "notes",
  "ownerId": "ownerId",
  "clientLoginId": "clientLoginId",
  "interestsAndHobbies": "interestsAndHobbies",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "displayOrder": 0,
  "salesOrderProcessorId": "salesOrderProcessorId",
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    }
  },
  "attributes": {},
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "salesOrderProcessor": {
    "id": "id",
    "name": "name",
    "type": "Location"
  },
  "clientLogin": {
    "id": "id",
    "name": "name",
    "type": "ClientLogin"
  }
}

plain

Deletes an existing contact, by id.

DELETE

https://api.heart.work

/core-api/contacts/{id}

Deletes an existing contact, by id. › path Parameters

id

string · required

Unique id of the contact to delete.

Deletes an existing contact, by id. › Responses

No data returned

DELETE/core-api/contacts/{id}

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

shell

Example Responses

No example specified for this content type

Searches contacts based on specific property values.

GET

https://api.heart.work

/core-api/contacts

Searches contacts 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:

DisplayName

ModifiedAt

Query

string

ids

string[]

external_references

string[]

job_titles

string[]

owner_ids

string[]

tags

string[]

Searches contacts based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/contacts

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "firstName": "firstName",
      "lastName": "lastName",
      "displayName": "displayName",
      "middleName": "middleName",
      "description": "description",
      "dateOfBirth": "2024-08-25T15:00:00Z",
      "gender": "gender",
      "title": "title",
      "jobTitle": "jobTitle",
      "notes": "notes",
      "ownerId": "ownerId",
      "clientLoginId": "clientLoginId",
      "interestsAndHobbies": "interestsAndHobbies",
      "addresses": [
        {
          "addressType": "addressType",
          "street": "street",
          "zipCode": "zipCode",
          "city": "city",
          "country": "country"
        }
      ],
      "emails": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "phoneNumbers": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "links": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "lastContactMoment": "2024-08-25T15:00:00Z",
      "displayOrder": 0,
      "salesOrderProcessorId": "salesOrderProcessorId",
      "commerceSettings": {
        "priceSettings": {
          "showSalesPrice": true,
          "showCustomerPrice": true,
          "showSuggestedRetailPrice": true
        }
      },
      "attributes": {},
      "connections": [
        {
          "label": "label",
          "reverseLabel": "reverseLabel",
          "type": "type",
          "entity": {
            "id": "id",
            "name": "name",
            "type": "Account"
          }
        }
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "tags": [
        "string"
      ],
      "owner": {
        "id": "id",
        "name": "name",
        "type": "HeartworkUser"
      },
      "salesOrderProcessor": {
        "id": "id",
        "name": "name",
        "type": "Location"
      },
      "clientLogin": {
        "id": "id",
        "name": "name",
        "type": "ClientLogin"
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new contact.

POST

https://api.heart.work

/core-api/contacts

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

Creates and stores a new contact. › Request Body

firstName

string · required

lastName

string · required

displayOrder

integer · int32 · required

externalReference

string

middleName

string

description

string

dateOfBirth

string · date-time

gender

string

title

string

jobTitle

string

notes

string

ownerId

string

clientLoginId

string

interestsAndHobbies

string

object[]

lastContactMoment

string · date-time

salesOrderProcessorId

string

object

object[]

tags

string[]

Creates and stores a new contact. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

firstName

string · required

lastName

string · required

displayName

string · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

tags

string[] · required

externalReference

string

middleName

string

description

string

dateOfBirth

string · date-time

gender

string

title

string

jobTitle

string

notes

string

ownerId

string

clientLoginId

string

interestsAndHobbies

string

lastContactMoment

string · date-time

salesOrderProcessorId

string

object

POST/core-api/contacts

curl --request POST \
  --url https://api.heart.work/core-api/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "firstName": "firstName",
  "lastName": "lastName",
  "middleName": "middleName",
  "description": "description",
  "dateOfBirth": "2024-08-25T15:00:00Z",
  "gender": "gender",
  "title": "title",
  "jobTitle": "jobTitle",
  "notes": "notes",
  "ownerId": "ownerId",
  "clientLoginId": "clientLoginId",
  "interestsAndHobbies": "interestsAndHobbies",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "displayOrder": 0,
  "salesOrderProcessorId": "salesOrderProcessorId",
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    }
  },
  "attributes": {},
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "firstName": "firstName",
  "lastName": "lastName",
  "middleName": "middleName",
  "description": "description",
  "dateOfBirth": "2024-08-25T15:00:00Z",
  "gender": "gender",
  "title": "title",
  "jobTitle": "jobTitle",
  "notes": "notes",
  "ownerId": "ownerId",
  "clientLoginId": "clientLoginId",
  "interestsAndHobbies": "interestsAndHobbies",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "displayOrder": 0,
  "salesOrderProcessorId": "salesOrderProcessorId",
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    }
  },
  "attributes": {},
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "firstName": "firstName",
  "lastName": "lastName",
  "displayName": "displayName",
  "middleName": "middleName",
  "description": "description",
  "dateOfBirth": "2024-08-25T15:00:00Z",
  "gender": "gender",
  "title": "title",
  "jobTitle": "jobTitle",
  "notes": "notes",
  "ownerId": "ownerId",
  "clientLoginId": "clientLoginId",
  "interestsAndHobbies": "interestsAndHobbies",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "displayOrder": 0,
  "salesOrderProcessorId": "salesOrderProcessorId",
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    }
  },
  "attributes": {},
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "salesOrderProcessor": {
    "id": "id",
    "name": "name",
    "type": "Location"
  },
  "clientLogin": {
    "id": "id",
    "name": "name",
    "type": "ClientLogin"
  }
}

plain

Get all filterable values for contacts

GET

https://api.heart.work

/core-api/contacts/filters

Get all filterable values for contacts › Responses

object[] · required

tags

string[] · required

jobTitles

string[] · required

GET/core-api/contacts/filters

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

shell

Example Responses

{
  "connections": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "owners": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "jobTitles": [
    "string"
  ]
}

plain

Fetches all used contact unique tags

GET

https://api.heart.work

/core-api/masterdata/contacts/tags

Fetches all used contact unique tags › Responses

string[]

GET/core-api/masterdata/contacts/tags

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

shell

Example Responses

[
  "string"
]

plain

Fetches all used contact unique jobtitles

GET

https://api.heart.work

/core-api/masterdata/contacts/jobtitles

Fetches all used contact unique jobtitles › Responses

string[]

GET/core-api/masterdata/contacts/jobtitles

curl --request GET \
  --url https://api.heart.work/core-api/masterdata/contacts/jobtitles

shell

Example Responses

[
  "string"
]

plain

Comments ContentPages