Skip to main content
GET
/
vaccines
/
{id}
Get a vaccine by id
curl --request GET \
  --url https://api.ceibo.me/v1/vaccines/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": 1,
  "code": "yellow_fever",
  "name": "Yellow Fever Vaccine",
  "diseaseName": "Yellow Fever",
  "dosesRequired": 1,
  "boosterRequired": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "whoName": "Yellow fever vaccine (live, attenuated)",
  "alternativeNames": [
    "YF-VAX",
    "Stamaril"
  ],
  "description": "<string>",
  "immunityDurationDays": 3650,
  "minimumDaysBeforeTravel": 10,
  "officialInfoUrl": "https://www.who.int/news-room/fact-sheets/detail/yellow-fever"
}

Authorizations

​
x-api-key
string
header
required

API key minted at developer.ceibo.me. Send on every request.

Path Parameters

​
id
integer
required

Response

The vaccine.

​
id
integer
required
Example:

1

​
code
string
required
Example:

"yellow_fever"

​
name
string
required
Example:

"Yellow Fever Vaccine"

​
diseaseName
string
required
Example:

"Yellow Fever"

​
dosesRequired
integer
required
Required range: x >= 1
Example:

1

​
boosterRequired
boolean
required
Example:

false

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
whoName
string | null
Example:

"Yellow fever vaccine (live, attenuated)"

​
alternativeNames
string[] | null
Example:
["YF-VAX", "Stamaril"]
​
description
string | null
​
immunityDurationDays
integer | null
Example:

3650

​
minimumDaysBeforeTravel
integer | null
Example:

10

​
officialInfoUrl
string | null
Example:

"https://www.who.int/news-room/fact-sheets/detail/yellow-fever"