CLclinicos
Patients

Get a paginated list of patients with optional filters

Changed on
get/Patients

Request

Query parameters

integer
OR
string int32

Page number (default: 1)

integer
OR
string int32

Number of items per page (default: 20)

clientIdstring

Filter by client ID

speciesstring

Filter by species

querystring

Search query matching patient name, breed, microchip number, or owner name; multiple words are ANDed so "Max Myers" finds patient Max owned by Myers; a full patient ID matches that patient exactly

sortBystring

Field to sort by

sortOrderstring

Sort order (asc/desc)

includeInactiveboolean
tagIdstring

Response

Paginated list of patients with appointment summary data

Example response

{
  "data": [
    {
      "species": "Dog",
      "breed": "Golden Retriever"
    }
  ]
}

Changes

  • 021fabd866ffRevision changes
    • info

      added the optional property // to the response with the status (media type: text/plain)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/json)