Skip to main content
POST
/
v1
/
organisations
/
{organisationId}
/
pms-integrations
Create PMS integration
curl --request POST \
  --url https://api.halth.com/v1/organisations/{organisationId}/pms-integrations \
  --header 'Content-Type: application/json' \
  --data '
{
  "pmsType": "cliniko",
  "apiKey": "<string>"
}
'
{
  "id": "<string>",
  "pmsType": "cliniko",
  "maskedApiKey": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.halth.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
organisationId
string
required
Example:

"org_31XEcUshz1ymodA14HALnyP48g1"

Body

application/json
​
pmsType
enum<string>
required
Available options:
cliniko,
nookal_v2,
splose
​
apiKey
string
required

Response

201 - application/json
​
id
string
required
​
pmsType
enum<string>
required
Available options:
cliniko,
nookal_v2,
splose
​
maskedApiKey
string