The /Perks endpoint focuses on the current list of lost pets posted on PetHub.com. Use this to create, read/pull, update and delete Lost Pet Posters.

Digging into /Perks

The /perks endpoint offers the following:

The Swagger 2.0 / OAS YAML rendering is below including the data structures necessary for POST or returned by GET.

The /LostPets endpoint focuses on the current list of lost pets posted on PetHub.com. Use this to create, read/pull, update and delete Lost Pet Posters.

Digging into /LostPets

The /lostpets endpoint offers the following:

The Swagger 2.0 / OAS YAML rendering is below including the data structures necessary for POST or returned by GET.

The /types endpoint focuses on the types of data that can be associated with a pet's profile on PetHub.com. Use this to retrieve the list of type names and unique IDs to associate with a pet's profile information.

This endpoint:

The HTTP response status codes that PetHub API utilizes are currently:

• 200 - OK
• 201 - Created
• 400 - Bad request
• 404 - Not found
• 500 - Internal server error

In addition to returning an HTTP response to a request to a PetHub.io API, we hope to actually provide some helpful information in the event of an error (but, if we miss that mark, please let us know so we can do our best to address it).

Request Errors

In addition to the HTTP response code above being returned, when an error occurs we will endeavor to have it include the following fields to help you (and possibly us) in diagnosing the problem:

• response_code - HTTP status code (see above)
• message - verbose, plain language description of the problem with hints of how to fix it
• more_info - link to any supporting documentation
• code - API error code defined in the PetHub API documentation to further identify the issue

For example, let's attempt to look-up the information for our beloved Grizzly (the original tester dog) where an access token is not included in the Header of the request:

curl GET https://pethub.io/v1/pets/321

Should have been:
curl -H "Authorization: Bearer abc123" GET https://pethub.io/v1/pets/321

The response would look something like the following:

HTTP Status Code: 401

{
    "response_code" : "401",
    "message" : "Header is missing or includes an invalid access token",
    "more_info" : "https://pethub.io/api/v1/auth,https://pethub.io/errors/202201100",
    "code" : "202201100"
}

Helpful API provided by Petfinder (requires API key sign-up).

The /pets endpoint focuses on the pet profile on PetHub.com. Use this to create a pet profile, retrieve a pet's information, and update its details as documented here.

The main parameter of this endpoint is the pet ID {pid} which is a UUID for a pet.

Digging into /Pets

The /pets endpoint offers the following:

The Swagger 2.0 / OAS YAML rendering is below including the data structures necessary for POST or returned by GET.

The /Persons endpoint focuses on the user account on PetHub.com.

Use this to create a user account, retrieve a user's information, update their details, and retrieve a list of content they own (including pet profiles, documents, safety contacts, and so on). Then, if it is necessary to dive deeper into detail, use the other APIs to access specific details about those Types of content.

Security: this information is only available if the user has provided both access to the requesting application and permissions to access the type of information being requested. If a user provides access to their account but has not given permission to view Documents or Insurance information, for example, an error 400 (Bad Request) will be returned.

Digging into /Persons

The /persons endpoint:

¹ {uuid} is the universally unique identifier returned when a GET request is made to the /persons endpoint by an authorized API integrator

The Swagger 2.0 / OAS YAML rendering is below including the data structures necessary for POST or returned by GET.

PetHub APIs support a number of endpoints that, with your feedback, we will continue to add to our library. The APIs below are what are currently in our catalog.

We've broken these up into 3 sections:

• Sniffing Around - both the most commonly used API calls for starting an interaction with a user's account and also the calls you'll need when initially registering your application with PetHub and getting a user's permission to utilize their data
• Digging Deeper - endpoints that help you dig deeper into a user's or pet's information
• Webhooks - proactively pull information as well as register to have PetHub notify you when specific events have taken place (such as tags being scanned or lost pet alerts being sent, for example)

The fun stuff:

• Sniffing Around:
  • Authorizations - before a 3rd party application may interact with a PetHub user's account and data, it may first receive authorization from the PetHub user
  • Persons - the end-user with the account on PetHub who has control of their own and their pet's content
  • Pets - the profiles of the animals managed by the PetHub platform
• Digging Deeper:
  • Activities - walking, agility, eating, playing, training, sleeping, pooping, and more. This is how you list it and add to it for a particular pet
  • Foods - manufacturer, formula, type (wet? kibble? raw?), amount, timing, and special preparation instructions can be found or added to for a pet with this endpoint
  • LostPets - pull a list of lost pet posters for a user, specific pet, by geo location, and more. Or, add to our list of Lost Pet posters
  • Perks - view which discounts a PetHub subscriber has claimed or the entire list of Perks that could be claimed
  • Species - pull the list of species supported by the PetHub platform or look-up the species for a specific pet
  • Tags - ability to look-up tag information including a pet's profile information if publicly published by the pet owner
• Webhooks:
  • Alerts - announcements about missing or found animals
  • Notifications - tag scanning events (webhook) for a particular pet or particular tag ID

Each of these can be accessed with permission from the user whose data is being requested. In addition, the user can see which applications have been given permission to use their data which can be revoked at any time. Lastly, the user can control which of these types of resources each application is allowed to access on a read / write / update / delete basis.

In the case of our favorite original tester, Grizzly, requesting his information would take the following form:

curl -H "Authorization: Bearer abc123" GET https://pethub.io/v1/pets/223

The above authorized call to PetHub.io's "/v1/pets/{id}" endpoint with Grizzly's unique identifier (where "223" replaces the "{id}") would receive the following response:

{
    "pid": "223",
    "uid": "66",
    "name": "Grizzly",
    "species": {
      "tid": "3031"
    },
    "breed_primary": {
      "target_id": "2855"
    },
    "breed_mix": "Chihuahua",
    "gender": "Male",
    "picture": {
      "fid": "189",
      "uid": "66",
      "filename": "grizzly.jpg",
      "filemime": "image/jpeg",
      "filesize": "7735",
      "status": "1",
      "timestamp": "1414801248",
      "type": "image",
      "metadata": {
        "height": 280,
        "width": 186
      },
      "height": "280",
      "width": "186",
      "url": "https://images.pethub.com/dev/pub/grizzly.jpg?milgJeq.a.UHYX6vfvnF7f2alm0p1Y5H"
    },
    "birthday": "2013-11-16 00:00:00",
    "size": {
      "tid": "3236"
    },
    "weight_value": "4",
    "weight_unit": "lb",
    "coat": "Short Hair",
    "tail": {
      "tid": "3428"
    },
    "altered": {
      "value": "Yes"
    },
    "description": "Our precious fuzzi-wuzzums.",
    "microchip": ""
  }

The format of the data above is JSON which is the default format typically specified in the Header as part of the request. However, if necessary, the format can be explicitly requested by appending ".json" or ".xml" to the noun to receive JSON or XML formatted data, respectively. For example:

curl -H "Authorization: Bearer abc123" GET https://pethub.io/v1/pets.json/223