For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • Home
  • API Reference
        • GETVaccines
        • GETVaccine by Code
        • GETVaccine Categories
        • GETVaccine Funding Types
        • GETVaccine Types
        • GETRoutes of Administration
        • GETAntigens
        • GETAntigen by Code
        • GETCountries
        • GETGenders
        • GETAntenatal Age Range
        • GETMandatory Vaccine Batch
        • GETMandatory Route of Administration
        • GETMandatory Vaccine Type
        • GETMandatory Antenatal Indicator
        • GETAllowable Medical Contraindication
        • GETAllowable Natural Immunity
  • Guides
    • Minor ID Setup
    • Architecture
    • Security & Governance
    • PRODA
    • DVA Integration
    • AIR Integration
    • Integration test data
    • Troubleshooting
LogoLogo
API ReferenceAIRReference Data

Vaccines

||View as Markdown|
GET
/AIR/v1/refdata/vaccine
GET
/AIR/v1/refdata/vaccine
$curl -G https://api.rebateright.com.au/AIR/v1/refdata/vaccine \
>     -H "x-api-key: <apiKey>" \
>     -d vaccineCategoryCode=
1{
2  "statusCode": "AIR-I-1100",
3  "codeType": "AIRIBU",
4  "message": "Your request was successfully processed.",
5  "vaccines": [
6    {
7      "vaccineCode": "ABRSV",
8      "vaccineName": "ABRYSVO",
9      "vaccineCategoryCode": "NONST",
10      "startDate": "1996-01-01",
11      "endDate": "9999-09-09",
12      "antigens": [
13        {
14          "antigenCode": "RSV",
15          "antigenName": "Respiratory Syncytial virus",
16          "maximumDose": 20,
17          "isNaturalImmunityValid": false
18        }
19      ],
20      "isMedicalContraindicationValid": false,
21      "isVaccineBatchMandatory": true,
22      "vaccineBatchMandatoryStartDate": "2024-03-01",
23      "vaccineBatchMandatoryEndDate": "9999-09-09"
24    }
25  ],
26  "correlationId": "urn:uuid:MDE00000000000000000000000"
27}
List every vaccine recognised by AIR with its full metadata — antigens, category, funding type, route, batch/type/antenatal mandates, dose limits, validity dates. Optionally filter by `vaccineCategoryCode` (e.g. `FLU`, `NIP`, `COV19`, `NONST`) to narrow the result to one category. For shared response patterns see [AIR Integration](/air).
Was this page helpful?
Previous

Record Natural Immunity

Next

Vaccine by Code

Built with

List every vaccine recognised by AIR with its full metadata — antigens, category, funding type, route, batch/type/antenatal mandates, dose limits, validity dates.

Optionally filter by vaccineCategoryCode (e.g. FLU, NIP, COV19, NONST) to narrow the result to one category.

For shared response patterns see AIR Integration.

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring
API Key authentication via header

Query parameters

vaccineCategoryCodestringOptional

Optional. Filter to a single category (e.g. FLU, NIP, COV19, NONST). See the Vaccine Categories lookup for valid values.

Response

OK
statusCodestring
codeTypestring
messagestring
vaccineslist of objects
correlationIdstring