healthcare
slot

Retrieve a slot

get/healthcare/{connection_id}/slot/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/healthcare/{connection_id}/slot/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Slot

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the slot

created_atstring date-time

When the slot was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the slot was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

practitioner_idstring

The practitioner whose schedule the slot belongs to

location_idstring

Where the slot takes place

status'FREE' | 'BUSY' | 'BUSY_UNAVAILABLE' | 'BUSY_TENTATIVE' | 'ENTERED_IN_ERROR' | 'OTHER'

Availability of the slot

start_atstring date-time

When the slot starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

When the slot ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_overbookedboolean

Whether the slot has been overbooked

notesstring

Free-text notes about the slot

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.