Heartwork API

Identities

Endpointhttps://api.heart.work

Download schema

Searches client logins based on specific property values.

GET

https://api.heart.work

/core-api/identities

Searches client logins 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:

Query

string

ids

string[]

external_references

string[]

Searches client logins based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/identities

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "username": "username",
      "email": "email",
      "profile": {
        "cloudMessagingToken": "cloudMessagingToken",
        "catalog": {
          "recentSearches": [
            "string"
          ],
          "recentlyViewed": [
            "string"
          ]
        },
        "ordering": {
          "shoppingCart": [
            {
              "productId": "productId",
              "quantity": 0,
              "attributes": [
                {
                  "key": "key",
                  "value": "value"
                }
              ]
            }
          ]
        },
        "preferredLanguage": "preferredLanguage"
      }
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/identities

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

email

string · required

password

string · required

username

string · required

displayName

string · required

object

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

POST/core-api/identities

curl --request POST \
  --url https://api.heart.work/core-api/identities \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "email",
  "password": "password",
  "username": "username",
  "displayName": "displayName",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}
'

shell

Example Request Body

{
  "email": "email",
  "password": "password",
  "username": "username",
  "displayName": "displayName",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

GET

https://api.heart.work

/core-api/identities/{id}

id

string · required

Unique id of the client login to fetch.

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

GET/core-api/identities/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

PUT

https://api.heart.work

/core-api/identities/{id}

On success, returns the updated entity in the response.

id

string · required

email

string · required

username

string · required

object

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

PUT/core-api/identities/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/identities/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "email",
  "username": "username",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}
'

shell

Example Request Body

{
  "email": "email",
  "username": "username",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

DELETE

https://api.heart.work

/core-api/identities/{id}

id

string · required

Unique id of the client login to delete.

No Content

No data returned

DELETE/core-api/identities/{id}

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

shell

Example Responses

No example specified for this content type

Check if an email is available in the current workspace.

GET

https://api.heart.work

/core-api/identities/emails/{email}/available

Check if an email is available in the current workspace. › path Parameters

email

string · required

Email of the client login you want to check.

Check if an email is available in the current workspace. › Responses

available

boolean · required

GET/core-api/identities/emails/{email}/available

curl --request GET \
  --url https://api.heart.work/core-api/identities/emails/:email/available

shell

Example Responses

{
  "available": true
}

plain

Check if a username is available in the current workspace.

GET

https://api.heart.work

/core-api/identities/usernames/{username}/available

Check if a username is available in the current workspace. › path Parameters

username

string · required

Username of the client login you want to check.

Check if a username is available in the current workspace. › Responses

available

boolean · required

GET/core-api/identities/usernames/{username}/available

curl --request GET \
  --url https://api.heart.work/core-api/identities/usernames/:username/available

shell

Example Responses

{
  "available": true
}

plain

GET

https://api.heart.work

/core-api/identities/external/{externalReference}

externalReference

string · required

Unique id of the client login to fetch.

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

GET/core-api/identities/external/{externalReference}

curl --request GET \
  --url https://api.heart.work/core-api/identities/external/:externalReference

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

FavouriteProducts Info

Heartwork API

Identities

Endpointhttps://api.heart.work

Download schema

Searches client logins based on specific property values.

GET

https://api.heart.work

/core-api/identities

Searches client logins 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:

Query

string

ids

string[]

external_references

string[]

Searches client logins based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/identities

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "username": "username",
      "email": "email",
      "profile": {
        "cloudMessagingToken": "cloudMessagingToken",
        "catalog": {
          "recentSearches": [
            "string"
          ],
          "recentlyViewed": [
            "string"
          ]
        },
        "ordering": {
          "shoppingCart": [
            {
              "productId": "productId",
              "quantity": 0,
              "attributes": [
                {
                  "key": "key",
                  "value": "value"
                }
              ]
            }
          ]
        },
        "preferredLanguage": "preferredLanguage"
      }
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/identities

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

email

string · required

password

string · required

username

string · required

displayName

string · required

object

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

POST/core-api/identities

curl --request POST \
  --url https://api.heart.work/core-api/identities \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "email",
  "password": "password",
  "username": "username",
  "displayName": "displayName",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}
'

shell

Example Request Body

{
  "email": "email",
  "password": "password",
  "username": "username",
  "displayName": "displayName",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

GET

https://api.heart.work

/core-api/identities/{id}

id

string · required

Unique id of the client login to fetch.

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

GET/core-api/identities/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

PUT

https://api.heart.work

/core-api/identities/{id}

On success, returns the updated entity in the response.

id

string · required

email

string · required

username

string · required

object

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

PUT/core-api/identities/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/identities/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "email",
  "username": "username",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}
'

shell

Example Request Body

{
  "email": "email",
  "username": "username",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

DELETE

https://api.heart.work

/core-api/identities/{id}

id

string · required

Unique id of the client login to delete.

No Content

No data returned

DELETE/core-api/identities/{id}

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

shell

Example Responses

No example specified for this content type

Check if an email is available in the current workspace.

GET

https://api.heart.work

/core-api/identities/emails/{email}/available

Check if an email is available in the current workspace. › path Parameters

email

string · required

Email of the client login you want to check.

Check if an email is available in the current workspace. › Responses

available

boolean · required

GET/core-api/identities/emails/{email}/available

curl --request GET \
  --url https://api.heart.work/core-api/identities/emails/:email/available

shell

Example Responses

{
  "available": true
}

plain

Check if a username is available in the current workspace.

GET

https://api.heart.work

/core-api/identities/usernames/{username}/available

Check if a username is available in the current workspace. › path Parameters

username

string · required

Username of the client login you want to check.

Check if a username is available in the current workspace. › Responses

available

boolean · required

GET/core-api/identities/usernames/{username}/available

curl --request GET \
  --url https://api.heart.work/core-api/identities/usernames/:username/available

shell

Example Responses

{
  "available": true
}

plain

GET

https://api.heart.work

/core-api/identities/external/{externalReference}

externalReference

string · required

Unique id of the client login to fetch.

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

username

string · required

email

string · required

object · required

externalReference

string

GET/core-api/identities/external/{externalReference}

curl --request GET \
  --url https://api.heart.work/core-api/identities/external/:externalReference

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "username": "username",
  "email": "email",
  "profile": {
    "cloudMessagingToken": "cloudMessagingToken",
    "catalog": {
      "recentSearches": [
        "string"
      ],
      "recentlyViewed": [
        "string"
      ]
    },
    "ordering": {
      "shoppingCart": [
        {
          "productId": "productId",
          "quantity": 0,
          "attributes": [
            {
              "key": "key",
              "value": "value"
            }
          ]
        }
      ]
    },
    "preferredLanguage": "preferredLanguage"
  }
}

plain

FavouriteProducts Info

Identities

Searches client logins based on specific property values.

Searches client logins based on specific property values. › query Parameters

Searches client logins based on specific property values. › Responses

Creates and stores a new client login.

Creates and stores a new client login. › Request Body

Creates and stores a new client login. › Responses

Fetches a single client login, by id.

Fetches a single client login, by id. › path Parameters

Fetches a single client login, by id. › Responses

Updates an existing client login, replacing it entirely.

Updates an existing client login, replacing it entirely. › path Parameters

Updates an existing client login, replacing it entirely. › Request Body

Updates an existing client login, replacing it entirely. › Responses

Deletes an existing client login, by id.

Deletes an existing client login, by id. › path Parameters

Deletes an existing client login, by id. › Responses

Check if an email is available in the current workspace.

Check if an email is available in the current workspace. › path Parameters

Check if an email is available in the current workspace. › Responses

Check if a username is available in the current workspace.

Check if a username is available in the current workspace. › path Parameters

Check if a username is available in the current workspace. › Responses

Fetches a single client login, by external id.

Fetches a single client login, by external id. › path Parameters

Fetches a single client login, by external id. › Responses

Identities

Searches client logins based on specific property values.

Searches client logins based on specific property values. › query Parameters

Searches client logins based on specific property values. › Responses

Creates and stores a new client login.

Creates and stores a new client login. › Request Body

Creates and stores a new client login. › Responses

Fetches a single client login, by id.

Fetches a single client login, by id. › path Parameters

Fetches a single client login, by id. › Responses

Updates an existing client login, replacing it entirely.

Updates an existing client login, replacing it entirely. › path Parameters

Updates an existing client login, replacing it entirely. › Request Body

Updates an existing client login, replacing it entirely. › Responses

Deletes an existing client login, by id.

Deletes an existing client login, by id. › path Parameters

Deletes an existing client login, by id. › Responses

Check if an email is available in the current workspace.

Check if an email is available in the current workspace. › path Parameters

Check if an email is available in the current workspace. › Responses

Check if a username is available in the current workspace.

Check if a username is available in the current workspace. › path Parameters

Check if a username is available in the current workspace. › Responses

Fetches a single client login, by external id.

Fetches a single client login, by external id. › path Parameters

Fetches a single client login, by external id. › Responses