> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ceibo.me/llms.txt
> Use this file to discover all available pages before exploring further.

# List or search vaccines

> Paginated catalogue of vaccines. Pass `q` to perform free-text search across name and disease.



## OpenAPI

````yaml GET /vaccines
openapi: 3.1.0
info:
  title: Ceibo API
  description: >-
    Travel platform data API: countries, cities, points of interest, walking
    tours, and entry requirements.
  version: 1.0.0
  contact:
    name: Ceibo Support
    email: support@ceibo.me
    url: https://developer.ceibo.me
servers:
  - url: https://api.ceibo.me/v1
    description: Production
security:
  - apiKey: []
paths:
  /vaccines:
    get:
      summary: List or search vaccines
      description: >-
        Paginated catalogue of vaccines. Pass `q` to perform free-text search
        across name and disease.
      parameters:
        - name: q
          in: query
          description: Free-text search across vaccine name and disease.
          required: false
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
        - name: sortOrder
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
      responses:
        '200':
          description: Paginated list of vaccines.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedVaccines'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PaginatedVaccines:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Vaccine'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Vaccine:
      type: object
      required:
        - id
        - code
        - name
        - diseaseName
        - dosesRequired
        - boosterRequired
        - createdAt
        - updatedAt
      properties:
        id:
          type: integer
          example: 1
        code:
          type: string
          example: yellow_fever
        name:
          type: string
          example: Yellow Fever Vaccine
        diseaseName:
          type: string
          example: Yellow Fever
        whoName:
          type:
            - string
            - 'null'
          example: Yellow fever vaccine (live, attenuated)
        alternativeNames:
          type:
            - array
            - 'null'
          items:
            type: string
          example:
            - YF-VAX
            - Stamaril
        description:
          type:
            - string
            - 'null'
        dosesRequired:
          type: integer
          minimum: 1
          example: 1
        boosterRequired:
          type: boolean
          example: false
        immunityDurationDays:
          type:
            - integer
            - 'null'
          example: 3650
        minimumDaysBeforeTravel:
          type:
            - integer
            - 'null'
          example: 10
        officialInfoUrl:
          type:
            - string
            - 'null'
          example: https://www.who.int/news-room/fact-sheets/detail/yellow-fever
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PaginationMeta:
      type: object
      required:
        - page
        - limit
        - total
        - totalPages
      properties:
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 20
        total:
          type: integer
          example: 195
        totalPages:
          type: integer
          example: 10
    Error:
      type: object
      required:
        - statusCode
        - code
        - message
        - timestamp
        - path
      properties:
        statusCode:
          type: integer
          example: 404
        code:
          type: string
          example: NOT_FOUND
        message:
          type: string
          example: Country with id 9999 not found
        timestamp:
          type: string
          format: date-time
          example: '2026-04-30T10:00:00.000Z'
        path:
          type: string
          example: /v1/countries/9999
  responses:
    Unauthorized:
      description: Missing, malformed, revoked, or unknown API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API key minted at developer.ceibo.me. Send on every request.

````