How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MedAdvisor Head Office API

The HeadOffice API from MedAdvisor — 6 operation(s) for headoffice.

MedAdvisor Head Office API is one of 14 APIs that MedAdvisor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include HeadOffice. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 8 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://pharmacy-unified.api.medadvisor.com.au.

8 operations 6 paths 4 schemas 4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://pharmacy-unified.api.medadvisor.com.au
Authentication
API Key
Resource Areas
1

Authentication & Security 1

MedAdvisor Head Office API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

  • Bearer — JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

HeadOffice 8
GET
/api/v1/hq/services
HeadOffice_GetServices → 200
POST
/api/v1/hq/services
Creates an HO custom service (RAP-38 Story 2.5). The service is owned by the caller's report group and is NOT pushed to any pharmacy — it lands in the catalogue as "Not pushed". Returns the created s…
HeadOffice_CreateService body → 200
GET
/api/v1/hq/pharmacies
HeadOffice_GetPharmacies → 200
GET
/api/v1/hq/services/{id}
HeadOffice_GetService 1 param → 200
PUT
/api/v1/hq/services/{id}
Edits an HO-owned service (RAP-38 Story 2.5). The change updates the shared service definition, so it applies to every pharmacy already linked to it — this does not push to new pharmacies. Returns th…
HeadOffice_UpdateService 1 param body → 200
GET
/api/v1/hq/pharmacies/{id}
HeadOffice_GetPharmacy 1 param → 200
PUT
/api/v1/hq/services/{id}/push/{pharmacyId}/deadline
Extends or shortens the auto-activation deadline on a pending push (RAP-38 Story 3a.5, AC1a). Shortening into the past is allowed — the nightly job picks it up on its next run.
HeadOffice_UpdatePushDeadline 2 params body → 200
POST
/api/v1/hq/services/{id}/push
Pushes an HO service to pharmacies in the group (RAP-38 Story 2.7) by scope — all, by state, or selected pharmacies. Force-links each target with visibility off (pushed, not yet live). Returns the pu…
HeadOffice_PushService 1 param body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoCreateServiceRequest (4 properties), MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoUpdateServiceRequest (4 properties), MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoPushServiceRequest (4 properties), MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoUpdatePushDeadlineRequest (1 property). Each schema is shown below with its type and property counts.

MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoPushServiceRequest
object
Push an HO service to pharmacies in the group (RAP-38 Story 2.7). Targets are always resolved within the caller's group. Scope is "all", "states", or "pharmaci…
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoUpdatePushDeadlineRequest
object
Extends or shortens the auto-activation deadline on an already-pushed, still-pending service (RAP-38 Story 3a.5, AC1a). Date-only. A past date is allowed — the…
1 property
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoUpdateServiceRequest
object
Payload to edit an existing HO-owned service (RAP-38 Story 2.5). Same fields as create. The edit updates the single shared PharmacyCapability, so it applies to…
4 properties
MedAdvisor.PharmacyUnifiedAPI.v1.Models.HoCreateServiceRequest
object
Payload to create a head-office custom service (RAP-38 Story 2.5). The created capability is owned by the caller's report group (OwnerReportGroupID) and has NO…
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medadvisor-headoffice-api-openapi.yml Raw ↑

Other APIs MedAdvisor publishes across the network.

MedAdvisor 3rd-Party Integration API
MedAdvisor Account API
MedAdvisor Booking API
MedAdvisor Booking Service API
MedAdvisor Calendar Setting API
MedAdvisor Clinic API
MedAdvisor Communication API
MedAdvisor Config API
MedAdvisor Inbox API
MedAdvisor Logging API
MedAdvisor Pharmacist API
MedAdvisor Pharmacy API
Where this information came from

This is an independent, third-party profile of MedAdvisor Head Office API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.