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

Antigen by Code

||View as Markdown|
GET
/AIR/v1/refdata/antigen/:antigenCode
GET
/AIR/v1/refdata/antigen/:antigenCode
$curl https://api.rebateright.com.au/AIR/v1/refdata/antigen/antigenCode \
> -H "x-api-key: <apiKey>"
200CAC
1{
2 "statusCode": "AIR-I-1100",
3 "codeType": "AIRIBU",
4 "message": "Your request was successfully processed.",
5 "antigens": [
6 {
7 "antigenCode": "CAC",
8 "antigenName": "COVID-19",
9 "maximumDose": 20,
10 "isNaturalImmunityValid": false
11 }
12 ],
13 "correlationId": "urn:uuid:MDE00000466ff9df88384944"
14}

Look up a single antigen by its AIR code. Returns the same shape as the Antigens list endpoint, scoped to one entry.

Was this page helpful?
Previous

Antigens

Next

Countries

Built with

Authentication

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

Path parameters

antigenCodestringRequired

AIR antigen code (e.g. CAC, HEP, FLU).

Response

OK
statusCodestring
codeTypestring
messagestring
antigenslist of objects
correlationIdstring