Heartwork API

ContentPages

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/cms/contentpages

query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

DisplayName

ids

string[]

external_references

string[]

languages

string[]

Responses

object[] · required

total

integer · int32 · required

GET/core-api/cms/contentpages

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "url": "url",
      "displayName": "displayName",
      "displayOrder": 0,
      "language": "language",
      "groupName": "groupName",
      "showInMenu": true,
      "showInFooter": true
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/cms/contentpages

Request Body

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

language

string · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

body

string

groupName

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

language

string

groupName

string

POST/core-api/cms/contentpages

curl --request POST \
  --url https://api.heart.work/core-api/cms/contentpages \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

plain

GET

https://api.heart.work

/core-api/cms/contentpages/{id}

path Parameters

id

string · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

language

string

groupName

string

GET/core-api/cms/contentpages/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

plain

PUT

https://api.heart.work

/core-api/cms/contentpages/{id}

path Parameters

id

string · required

Request Body

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

language

string · required

showInMenu

boolean · required

showInFooter

boolean · required

id

string · required

externalReference

string

body

string

groupName

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

language

string

groupName

string

PUT/core-api/cms/contentpages/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/cms/contentpages/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true,
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true,
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

plain

DELETE

https://api.heart.work

/core-api/cms/contentpages/{id}

path Parameters

id

string · required

Responses

No data returned

DELETE/core-api/cms/contentpages/{id}

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

shell

Example Responses

No example specified for this content type

Contacts Currencies

Heartwork API

ContentPages

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/cms/contentpages

query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

DisplayName

ids

string[]

external_references

string[]

languages

string[]

Responses

object[] · required

total

integer · int32 · required

GET/core-api/cms/contentpages

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "url": "url",
      "displayName": "displayName",
      "displayOrder": 0,
      "language": "language",
      "groupName": "groupName",
      "showInMenu": true,
      "showInFooter": true
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/cms/contentpages

Request Body

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

language

string · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

body

string

groupName

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

language

string

groupName

string

POST/core-api/cms/contentpages

curl --request POST \
  --url https://api.heart.work/core-api/cms/contentpages \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

plain

GET

https://api.heart.work

/core-api/cms/contentpages/{id}

path Parameters

id

string · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

language

string

groupName

string

GET/core-api/cms/contentpages/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

plain

PUT

https://api.heart.work

/core-api/cms/contentpages/{id}

path Parameters

id

string · required

Request Body

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

language

string · required

showInMenu

boolean · required

showInFooter

boolean · required

id

string · required

externalReference

string

body

string

groupName

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

url

string · required

displayName

string · required

displayOrder

integer · int32 · required

showInMenu

boolean · required

showInFooter

boolean · required

externalReference

string

language

string

groupName

string

PUT/core-api/cms/contentpages/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/cms/contentpages/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true,
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "body": "body",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true,
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "url": "url",
  "displayName": "displayName",
  "displayOrder": 0,
  "language": "language",
  "groupName": "groupName",
  "showInMenu": true,
  "showInFooter": true
}

plain

DELETE

https://api.heart.work

/core-api/cms/contentpages/{id}

path Parameters

id

string · required

Responses

No data returned

DELETE/core-api/cms/contentpages/{id}

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

shell

Example Responses

No example specified for this content type

Contacts Currencies