Heartwork API

Users

Endpointhttps://api.heart.work

Download schema

Filters the users based on optional filters

GET

https://api.heart.work

/core-api/users

Filters the users based on optional filters › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

DisplayName

Query

string

external_references

string[]

user_types

string[]

Enum values:

User

Client

Filters the users based on optional filters › Responses

object[] · required

total

integer · int32 · required

GET/core-api/users

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "userType": "User",
      "username": "username",
      "email": "email",
      "firstname": "firstname",
      "lastname": "lastname",
      "displayName": "displayName",
      "workspaces": [
        "string"
      ],
      "apps": [
        "string"
      ],
      "picture": "picture"
    }
  ],
  "total": 0
}

plain

Creates and stores a new user.

POST

https://api.heart.work

/core-api/users

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

Creates and stores a new user. › Request Body

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

password

string · required

apps

string[]

Creates and stores a new user. › Responses

id

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

userType

string · enum · required

Enum values:

User

Client

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

workspaces

string[] · required

apps

string[] · required

externalReference

string

picture

string

POST/core-api/users

curl --request POST \
  --url https://api.heart.work/core-api/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "password": "password"
}
'

shell

Example Request Body

{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "password": "password"
}

json

Example Responses

{
  "id": "id",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "userType": "User",
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "workspaces": [
    "string"
  ],
  "apps": [
    "string"
  ],
  "picture": "picture"
}

plain

Fetches a single user, by id.

GET

https://api.heart.work

/core-api/users/{id}

Fetches a single user, by id. › path Parameters

id

string · required

Unique id of the user to fetch.

Fetches a single user, by id. › Responses

id

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

userType

string · enum · required

Enum values:

User

Client

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

workspaces

string[] · required

apps

string[] · required

externalReference

string

picture

string

GET/core-api/users/{id}

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

shell

Example Responses

{
  "id": "id",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "userType": "User",
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "workspaces": [
    "string"
  ],
  "apps": [
    "string"
  ],
  "picture": "picture"
}

plain

Updates an existing user, replacing it entirely.

PUT

https://api.heart.work

/core-api/users/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

id

string · required

apps

string[]

Updates an existing user, replacing it entirely. › Responses

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

id

string · required

apps

string[]

PUT/core-api/users/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/users/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "id": "id"
}

json

Example Responses

{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "id": "id"
}

plain

Deletes an existing user, by id.

DELETE

https://api.heart.work

/core-api/users/{id}

Deletes an existing user, by id. › path Parameters

id

string · required

Unique id of the user to delete.

Deletes an existing user, by id. › Responses

No data returned

DELETE/core-api/users/{id}

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

shell

Example Responses

No example specified for this content type

Translations VatCodes

Heartwork API

Users

Endpointhttps://api.heart.work

Download schema

Filters the users based on optional filters

GET

https://api.heart.work

/core-api/users

Filters the users based on optional filters › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

DisplayName

Query

string

external_references

string[]

user_types

string[]

Enum values:

User

Client

Filters the users based on optional filters › Responses

object[] · required

total

integer · int32 · required

GET/core-api/users

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "userType": "User",
      "username": "username",
      "email": "email",
      "firstname": "firstname",
      "lastname": "lastname",
      "displayName": "displayName",
      "workspaces": [
        "string"
      ],
      "apps": [
        "string"
      ],
      "picture": "picture"
    }
  ],
  "total": 0
}

plain

Creates and stores a new user.

POST

https://api.heart.work

/core-api/users

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

Creates and stores a new user. › Request Body

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

password

string · required

apps

string[]

Creates and stores a new user. › Responses

id

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

userType

string · enum · required

Enum values:

User

Client

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

workspaces

string[] · required

apps

string[] · required

externalReference

string

picture

string

POST/core-api/users

curl --request POST \
  --url https://api.heart.work/core-api/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "password": "password"
}
'

shell

Example Request Body

{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "password": "password"
}

json

Example Responses

{
  "id": "id",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "userType": "User",
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "workspaces": [
    "string"
  ],
  "apps": [
    "string"
  ],
  "picture": "picture"
}

plain

Fetches a single user, by id.

GET

https://api.heart.work

/core-api/users/{id}

Fetches a single user, by id. › path Parameters

id

string · required

Unique id of the user to fetch.

Fetches a single user, by id. › Responses

id

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

userType

string · enum · required

Enum values:

User

Client

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

workspaces

string[] · required

apps

string[] · required

externalReference

string

picture

string

GET/core-api/users/{id}

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

shell

Example Responses

{
  "id": "id",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "userType": "User",
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "workspaces": [
    "string"
  ],
  "apps": [
    "string"
  ],
  "picture": "picture"
}

plain

Updates an existing user, replacing it entirely.

PUT

https://api.heart.work

/core-api/users/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

id

string · required

apps

string[]

Updates an existing user, replacing it entirely. › Responses

username

string · required

email

string · required

firstname

string · required

lastname

string · required

displayName

string · required

id

string · required

apps

string[]

PUT/core-api/users/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/users/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "id": "id"
}

json

Example Responses

{
  "username": "username",
  "email": "email",
  "firstname": "firstname",
  "lastname": "lastname",
  "displayName": "displayName",
  "apps": [
    "string"
  ],
  "id": "id"
}

plain

Deletes an existing user, by id.

DELETE

https://api.heart.work

/core-api/users/{id}

Deletes an existing user, by id. › path Parameters

id

string · required

Unique id of the user to delete.

Deletes an existing user, by id. › Responses

No data returned

DELETE/core-api/users/{id}

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

shell

Example Responses

No example specified for this content type

Translations VatCodes