Skip to content

List vaccinations

Request

Returns a paginated list of Vaccinations for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber, >= 0

Page number (0-indexed)

Default:0
pageSizenumber, [ 1 .. 100 ]

Number of items per page

Default:10
sortBystring

Field to sort by

Enum:"createdAt""updatedAt""administeredAt""description""nextAdministrationDate""notes""quantity""doseUnit""site""manufacturer"
sortOrderstring

Sort order

Default:"asc"
Enum:"asc""desc"
animalIdstring

Identifier of the animal that received the vaccination.

Example:animalId=123e4567-e89b-12d3-a456-426614174000
batchIdstring

Identifier or lot number of the vaccine batch used.

Example:batchId=123e4567-e89b-12d3-a456-426614174000
consultIdstring

Identifier of the consultation/visit during which the vaccination was administered.

Example:consultId=123e4567-e89b-12d3-a456-426614174000
descriptionstring

Free-text description of the vaccination or product.

isActiveboolean

Whether this vaccination record is currently active.

notesstring

Clinical notes related to this vaccination.

productIdstring

Identifier of the vaccine product used.

Example:productId=123e4567-e89b-12d3-a456-426614174000
salesResourceIdstring

Identifier linking this vaccination to a sales or billing resource.

Example:salesResourceId=123e4567-e89b-12d3-a456-426614174000
vetIdstring

Identifier of the veterinarian who administered or is responsible for the vaccination.

Example:vetId=123e4567-e89b-12d3-a456-426614174000
doseUnitstring

Unit of measure for the vaccine dose (e.g., mL, dose, IU).

sitestring

Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).

manufacturerstring

Name of the vaccine manufacturer as recorded at administration time.

herdGroupIdstring

Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.

Example:herdGroupId=123e4567-e89b-12d3-a456-426614174000
isBoosterboolean

Indicates whether this vaccination is a booster dose in a series.

curl -i -X GET \
  'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/vaccination?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&batchId=123e4567-e89b-12d3-a456-426614174000&consultId=123e4567-e89b-12d3-a456-426614174000&description=string&isActive=true&notes=string&productId=123e4567-e89b-12d3-a456-426614174000&salesResourceId=123e4567-e89b-12d3-a456-426614174000&vetId=123e4567-e89b-12d3-a456-426614174000&doseUnit=string&site=string&manufacturer=string&herdGroupId=123e4567-e89b-12d3-a456-426614174000&isBooster=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Vaccinations