Endpoints for creating and managing organisations which own or deal with billing for physical practice sites.
Upsert organisation
Creates or updates an organisation in the slipstream practice registry and returns a unique identifier
path Parameters
header Parameters
Request Body schema: application/jsonrequired
The details of the organisation to onboard
| Name required | string The human-readable name for the organisation. |
| Website | string <uri> The website for the organisation. |
| PrimaryEmailAddress | string <email> Primary email address for the organisation, used for general communications. |
| BillingEmailAddress | string <email> Primary email address for billing-specific mail for the organisation. |
| PhoneNumber | string <phone> Contact phone number for the organisation in E.164 format |
Organisation identity
Organisation identity
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- Payload
- curl
- Ruby
- C#
- Node.js
{- "Name": "Dental Mega Corp",
- "PrimaryEmailAddress": "admin@dental-mega-corp.com",
- "BillingEmailAddress": "billing@dental-mega-corp.com",
- "PhoneNumber": "+1 555-555-5555"
}- 200
- 201
- 400
- 401
- 403
- 429
- 4XX
- 5XX
{- "Name": "All your teeth are belong to us LTD",
- "PracticeManagementSoftware": "Unknown",
- "PmsSpecificOrganisationId": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003",
- "OrganisationSlug": "s8n6EzC"
}Get an organisation
Fetches the details of a given organisation in slipstream
path Parameters
header Parameters
| X-Practice-Management-Software | string (PracticeManagementSoftware) The intended practice management software for the request, used to disambiguate a pms specific identifier when you have access to multiple PMS systems. Omit this if you only have access to a single PMS.
|
The details of the requested organisation
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- curl
- Ruby
- C#
- Node.js
- 200
- 400
- 401
- 403
- 404
- 429
- 4XX
- 5XX
{- "Identity": {
- "Name": "All your teeth are belong to us LTD",
- "PracticeManagementSoftware": "Unknown",
- "PmsSpecificOrganisationId": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003",
- "OrganisationSlug": "s8n6EzC"
}, - "PrimaryEmailAddress": "admin@dental-mega-corp.com",
- "BillingEmailAddress": "billing@dental-mega-corp.com",
- "PhoneNumber": "+1 555-555-5555"
}Delete an organisation
Deletes an organisation from the slipstream practice registry. Will fail if the organisation owns any practice sites - delete the sites first
path Parameters
header Parameters
| X-Practice-Management-Software | string (PracticeManagementSoftware) The intended practice management software for the request, used to disambiguate a pms specific identifier when you have access to multiple PMS systems. Omit this if you only have access to a single PMS.
|
OK
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- curl
- Ruby
- C#
- Node.js
- 200
- 400
- 401
- 403
- 404
- 429
- 4XX
- 5XX
"fGkYxz"Get organisation identity
Fetches the identity of a given organisation in slipstream
path Parameters
header Parameters
| X-Practice-Management-Software | string (PracticeManagementSoftware) The intended practice management software for the request, used to disambiguate a pms specific identifier when you have access to multiple PMS systems. Omit this if you only have access to a single PMS.
|
Organisation identity
Malformed Request (ProblemDetails)
Unauthorized - Provide proof of identity (ProblemDetails)
Forbidden - Insufficient permissions (ProblemDetails)
Not Found - Could not find a matching entity (ProblemDetails)
Unprocessable - Request was well formed but could not be actioned (ProblemDetails)
Too many requests - Chill out (ProblemDetails)
User Error (ProblemDetails)
Server Error (ProblemDetails)
- curl
- Ruby
- C#
- Node.js
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 4XX
- 5XX
{- "Name": "All your teeth are belong to us LTD",
- "PracticeManagementSoftware": "Unknown",
- "PmsSpecificOrganisationId": "04d2f2f0-8f1a-11eb-8dcd-0242ac130003",
- "OrganisationSlug": "s8n6EzC"
}