Skip to content

Retrieve a site by ID

Request

Security
bearer
Path
siteIdnumberrequired
Query
userIdnumber

Filter by related userId (via UserSite relation)

Example:userId=42
namestring

The name of the site

Example:name=Downtown Clinic
clientAccountIdArray of numbers

The clientAccountId of the site

Example:clientAccountId=1
organizationIdArray of numbers

The organizationId of the site

Example:organizationId=1
brandIdArray of numbers

The brandId of the site

Example:brandId=1
curl -i -X GET \
  'https://docs.axiomera.com/_mock/apis/heydonto/openapi/site/{siteId}?userId=42&name=Downtown%20Clinic&clientAccountId=1&organizationId=1&brandId=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site retrieved successfully.

Bodyapplication/json
idnumberrequired

The ID of the site

Example:123
namestringrequired

The name of the site

Example:"Downtown Clinic"
addressobject(SiteAddressDto)required

The address information of the site

googlePlaceIdstringrequired

The Google Place ID for the site

Example:"ChIJN1t_tDeuEmsRUsoyG83frY4"
phoneNumberstring or null

The phone number of the site

Example:"+1 (555) 123-4567"
websitestring or null

The website of the site

Example:"https://downtownclinic.com"
anyDeskIpstring or null

The AnyDesk IP address for remote access

Example:"192.168.1.100"
createdByUserIdnumberrequired

The ID of the user who created the site

Example:202
createdAtstringrequired

The date and time the site was created

Example:"2021-05-01T12:00:00Z"
updatedAtstringrequired

The date and time the site was last updated

Example:"2021-05-01T12:00:00Z"
deletedAtstring or null

The date and time the site was deleted, if applicable

Example:"null"
clientAccountIdnumberrequired

The ID of the client account the site is associated with

Example:456
organizationIdnumberrequired

The ID of the organization the site belongs to

Example:789
brandIdnumberrequired

The ID of the brand the site is associated with

Example:101
practiceManagementSystemIdnumber or null

The ID of the practice management system used by the site

Example:202
integrationTypestringrequired

Integration type for the site

Default:"PMS"
Enum:"PMS""CUSTOM"
Example:"PMS"
outputDataStoreTypestringrequired

Output data store type for the site

Default:"FHIR_R4"
Enum:"FHIR_R4""AHDS_V1""CUSTOM""NONE"
Example:"FHIR_R4"
licenseKeystring or null

The license key for the site

Example:"XXX-YYY-ZZZ-AAA-BBB"
fhirStoreIdstring or null

The ID of the FHIR store associated with the site

Example:"fhir-store-123"
firstSyncDatestring or null

The date of the first sync with the site

Example:"2021-05-15T12:00:00Z"
latestSyncDatestring or null

The date of the most recent sync with the site

Example:"2021-06-01T12:00:00Z"
synchronizationIsActiveboolean or null

Indicates whether synchronization is active

Example:true
siteManagerUserIdnumberrequired

The ID of the user who manages the site

Example:303
cloudUserNamestring or null

The cloud username for the site

Example:"downtown.clinic"
cloudUserPasswordstring or null

The cloud user password for the site

Example:"encrypted-password"
cloudOrganizationNamestring or null

The name of the cloud organization for the site

Example:"HealthCorp Cloud"
cloudLoginUrlstring or null

The URL for cloud login

Example:"https://cloud.healthcorp.com/login"
clientAccountobject(SiteClientAccountDto)required

The client account associated with the site

organizationobject(SiteOrganizationDto)required

The organization the site belongs to

brandobject(SiteBrandDto)required

The brand the site is associated with

practiceManagementSystemobject(SitePracticeManagementSystemDto)required

The practice management system used by the site

createdByUserobject(SiteCreatedByUserDto)required

The user who created the site

siteUsersArray of objects(SiteUserDto)required

The users associated with the site

siteManagerUserobject(SiteManagerUserDto)required

The user who manages the site

integrationTosAcceptedAtstring, (date-time)required

The date and time the site accepted the integration TOS

Example:"2021-08-01T00:00:00.000Z"
Response
{ "id": 123, "name": "Downtown Clinic", "address": { "lat": 37.7749, "lng": -122.4194, "url": "https://maps.google.com/?q=123+Main+St", "formatted_address": "123 Main St, San Francisco, CA 94103" }, "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4", "phoneNumber": "+1 (555) 123-4567", "website": "https://downtownclinic.com", "anyDeskIp": "192.168.1.100", "createdByUserId": 202, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "deletedAt": "null", "clientAccountId": 456, "organizationId": 789, "brandId": 101, "practiceManagementSystemId": 202, "integrationType": "PMS", "outputDataStoreType": "FHIR_R4", "licenseKey": "XXX-YYY-ZZZ-AAA-BBB", "fhirStoreId": "fhir-store-123", "firstSyncDate": "2021-05-15T12:00:00Z", "latestSyncDate": "2021-06-01T12:00:00Z", "synchronizationIsActive": true, "siteManagerUserId": 303, "cloudUserName": "downtown.clinic", "cloudUserPassword": "encrypted-password", "cloudOrganizationName": "HealthCorp Cloud", "cloudLoginUrl": "https://cloud.healthcorp.com/login", "clientAccount": { "id": 456, "title": "HealthCorp Client", "phoneNumber": "+1 (555) 123-4567", "website": "https://healthcorp.com", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "organization": { "id": 123, "title": "HealthCorp", "website": "https://healthcorp.com", "isEnabled": true, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "brand": { "id": 789, "title": "HealthCorp Brand", "isEnabled": true, "organizationId": 123, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "practiceManagementSystem": { "id": 101, "title": "MedicalSoft Pro", "isCloudBased": true, "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "createdByUser": { "id": 202, "email": "john.doe@healthcorp.com", "firstName": "John", "lastName": "Doe", "role": "SITE_USER", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "siteUsers": [ { … } ], "siteManagerUser": { "id": 303, "email": "manager@healthcorp.com", "firstName": "Jane", "lastName": "Smith", "role": "SITE_MANAGER_USER", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "integrationTosAcceptedAt": "2021-08-01T00:00:00.000Z" }