Skip to main content
GET
/
patients
cURL
curl --request GET \
  --url https://api.cuddles.care/v1/patients \
  --header 'Authorization: Bearer <token>'
{
  "total": 12,
  "data": [
    {
      "firstName": "Scooby",
      "lastName": "Blu",
      "weight": 72,
      "dob": "2017-02-07",
      "ownedDate": "2017-09-11",
      "gender": "Male",
      "species": "Dog",
      "breedNature": "Pure",
      "sireName": "Loka",
      "damName": "Honey",
      "otherOrigin": null,
      "color": "Fawn",
      "microchip": "#979XX7FGF",
      "description": " He is  loyal and obedient, and he loves to be around people. He typically needs plenty of exercise and socialization, and  needs a large yard or space to run and play. He also require regular grooming and need a high-protein diet to maintain his health.",
      "breed": "Great Dane",
      "origin": "Pet Shop",
      "coatType": "Smooth",
      "coatLength": "Short",
      "petName": "Scooby Blu",
      "images": {
        "primary": {
          "id": "3fc66452-6a66-4d46-9ed1-5c232fae5200",
          "type": "image"
        },
        "default": "default-dog.svg"
      },
      "geoLocation": {
        "lon": -95.6587075,
        "lat": 29.6044443
      },
      "patientName": "Scooby Blu",
      "location": {
        "streetAddress": "6814 Bannon Trail",
        "aptSuiteOther": null,
        "city": "Sugar Land",
        "state": "Texas",
        "zip": 77479,
        "country": "USA",
        "neighborhood": null,
        "county": "Fort Bend County"
      },
      "type": "patient",
      "id": "f18f5cb8-df93-46b7-9fbf-0c06c1c73d05"
    },
    {
      "firstName": "David",
      "lastName": "Brane",
      "weight": 6,
      "dob": "2021-03-04",
      "ownedDate": null,
      "gender": "Male",
      "species": "Dog",
      "breedNature": "Pure",
      "sireName": null,
      "damName": null,
      "description": null,
      "petName": "David Brane",
      "images": {
        "default": "default-dog.svg"
      },
      "geoLocation": {
        "lat": 29.5973213,
        "lon": -95.6565995
      },
      "patientName": "David Brane",
      "location": {
        "streetAddress": "723 Doscher Ln",
        "aptSuiteOther": null,
        "city": "Sugar Land",
        "state": "Texas",
        "zip": 77479,
        "country": "USA",
        "neighborhood": "Telfair",
        "county": "Fort Bend County",
        "zipSuffix": "2750"
      },
      "type": "patient",
      "id": "de18da2f-3e3c-486b-8d67-aa86703f3649"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number of the list

Required range: x >= 1
​
limit
integer
default:10

Number of records to return per page

Required range: 1 <= x <= 100
​
createdFrom
string

Start creation date of the record Format of the date should be ISO format

​
createdTo
string

End creation date of the record Format of the date should be ISO format

​
updatedFrom
string

Start updated date of the record Format of the date should be ISO format

​
updatedTo
string

End updated date of the record Format of the date should be ISO format

​
practiceId
string

ID of practice from which records need to be filtered

Response

List of all patients

​
total
integer

Total count of the matched records

Example:

12

​
data
object[]

Array of patient records

Example:
[
  {
    "firstName": "Scooby",
    "lastName": "Blu",
    "weight": 72,
    "dob": "2017-02-07",
    "ownedDate": "2017-09-11",
    "gender": "Male",
    "species": "Dog",
    "breedNature": "Pure",
    "sireName": "Loka",
    "damName": "Honey",
    "otherOrigin": null,
    "color": "Fawn",
    "microchip": "#979XX7FGF",
    "description": " He is  loyal and obedient, and he loves to be around people. He typically needs plenty of exercise and socialization, and  needs a large yard or space to run and play. He also require regular grooming and need a high-protein diet to maintain his health.",
    "breed": "Great Dane",
    "origin": "Pet Shop",
    "coatType": "Smooth",
    "coatLength": "Short",
    "petName": "Scooby Blu",
    "images": {
      "primary": {
        "id": "3fc66452-6a66-4d46-9ed1-5c232fae5200",
        "type": "image"
      },
      "default": "default-dog.svg"
    },
    "geoLocation": { "lon": -95.6587075, "lat": 29.6044443 },
    "patientName": "Scooby Blu",
    "location": {
      "streetAddress": "6814 Bannon Trail",
      "aptSuiteOther": null,
      "city": "Sugar Land",
      "state": "Texas",
      "zip": 77479,
      "country": "USA",
      "neighborhood": null,
      "county": "Fort Bend County"
    },
    "type": "patient",
    "id": "f18f5cb8-df93-46b7-9fbf-0c06c1c73d05"
  },
  {
    "firstName": "David",
    "lastName": "Brane",
    "weight": 6,
    "dob": "2021-03-04",
    "ownedDate": null,
    "gender": "Male",
    "species": "Dog",
    "breedNature": "Pure",
    "sireName": null,
    "damName": null,
    "description": null,
    "petName": "David Brane",
    "images": { "default": "default-dog.svg" },
    "geoLocation": { "lat": 29.5973213, "lon": -95.6565995 },
    "patientName": "David Brane",
    "location": {
      "streetAddress": "723 Doscher Ln",
      "aptSuiteOther": null,
      "city": "Sugar Land",
      "state": "Texas",
      "zip": 77479,
      "country": "USA",
      "neighborhood": "Telfair",
      "county": "Fort Bend County",
      "zipSuffix": "2750"
    },
    "type": "patient",
    "id": "de18da2f-3e3c-486b-8d67-aa86703f3649"
  }
]