...
GET /api/pets
GET /api/pets/{pet_id}
GET /api/pets/{pet_id}/media
GET /api/pets {'limit': '2'} – gets all pets (for this example, limit = 2)
Response
| Code Block | ||
|---|---|---|
| ||
{
"count": 2,
"objects": [
{
"band": "",
"breed": {
"aliases": [
"Affen",
"Monkey Dog"
],
"custom_fields": {
"Height": null,
"Weight": null
},
"deleted": false,
"description": "Loyal, curious, and famously amusing, this almost-human toy dog is fearless out of all proportion to his size. As with all great comedians, it\u2019s the Affenpinscher\u2019s apparent seriousness of purpose that makes his antics all the more amusing.",
"display_behavior": "Only if Available",
"display_name": "Affenpinscher",
"id": -1,
"is_temp": false,
"slug": "affenpinschers"
},
"breed_id": -1,
"changed_at": "2022-06-15T18:12:02.126907-04:00",
"color_markings": "",
"cost": "1200.00",
"currently_at_entity_id": 4,
"custom_fields": null,
"deceased_on": null,
"deleted": false,
"entity_id": 4,
"gender": "Male",
"id": 7,
"identifiers": "",
"images": [
{
"deleted": false,
"description": "image_cropper_1602511783686.jpg",
"file": {
"basename": "image_cropper_1602511783686",
"checksum": [
60,
... removed additional values for example
148,
8
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "image_cropper_1602511783686.jpg",
"extension": "jpg",
"filename": "image_cropper_1602511783686.jpg",
"id": 6988,
"stored_at": "2020-10-12T10:09:53.793991-04:00"
},
"id": 28,
"image": {
"dimensions": [
100,
100
],
"id": 6988
},
"sort_order": 0,
"tags": []
}
],
"imported_identifier": null,
"is_marketing_notes_enabled": null,
"litter": {
"age": "375 weeks 1 day",
"birthdate": "2016-08-31",
"deleted": false,
"id": 7,
"notes": ""
},
"litter_id": 7,
"location": {
"attrs": null,
"deleted": false,
"entity": {
"address_1": "123 Main Street",
"address_2": "",
"attributes": {},
"businessname": "Pinogy Store",
"city": "Herndon",
"contact_numbers": {
"Office": "888-555-7381"
},
"created_at": "2015-12-09T12:59:15.033735-05:00",
"deleted": false,
"emails": {
"Office": "info@example.com"
},
"firstname": "",
"id": 4,
"is_active": true,
"iso_code": "VA",
"lastname": "",
"name": "Pinogy Store",
"notes": "",
"postal_code": "20170",
"region_fullname": "Virginia",
"role_ids": [
-2
],
"role_names": [
"Location"
],
"smart_search": "Pinogy Store Pinogy Store Location Herndon 123 Main Street Virginia VA 8885557381 888-555-7381 info@example.com Pinogy Store PS",
"sub_state": "",
"tax_exempt": false,
"updated_at": "2023-11-09T16:48:53.418141",
"url": ""
},
"id": 4,
"is_enabled": true,
"is_primary_store": true,
"is_public": true,
"latitude": null,
"logo": null,
"longitude": null,
"marketing_phone": null,
"max_safety_stock_days": 18,
"min_safety_stock_days": 18,
"open_hours": {
"Friday": [
"9:00 AM",
"9:00 PM"
],
"Monday": [
"9:00 AM",
"8:00 PM"
],
"Saturday": [
"9:00 AM",
"9:00 PM"
],
"Sunday": [
"11:00 AM",
"6:00 PM"
],
"Thursday": [
"9:00 AM",
"8:00 PM"
],
"Tuesday": [
"9:00 AM",
"8:00 PM"
],
"Wednesday": [
"9:00 AM",
"8:00 PM"
]
},
"pricing_group": {
"deleted": false,
"id": 1,
"name": "PrcGrp #1"
},
"receipt_name": "Pinogy Store",
"report_code": "PS",
"show_regional": true,
"slug": "pinogy-store",
"social_links": {
"Facebook": "https://facebook.com/example",
"Instagram": "https://instgram.com/mystore"
},
"updated_at": "2015-12-09T12:59:15.039683-05:00",
"website_url": "www.example.com"
},
"location_id": 4,
"marketing_notes": "Meet {NAME}! This gorgeous {SEX ? MALE=boy, FEMALE=girl, pup} is ready to make you {SEX ? MALE=his, FEMALE=her, their} new best friend. What a little sweetheart {SEX ? MALE=he, FEMALE=she, it} is. So full of energy and spunk, and can\u2019t wait to come home to you for belly rubs. {SEX ? MALE=He, FEMALE=She, It}\u2019s always ready to play and hopes you are too! {SEX ? MALE=He, FEMALE=She, It} is up to date on {SEX ? MALE=his, FEMALE=her, their} vaccinations and pre-spoiled before coming to your home. Don\u2019t miss out on this great puppy; {SEX ? MALE=He, FEMALE=She, It} can\u2019t wait to come home to your new family!",
"medical_condition_events": [
{
"deleted": false,
"diagnosed_on": "2016-10-26",
"id": 1,
"medical_condition_id": -7,
"notes": "",
"pet_id": 7
},
{
"deleted": false,
"diagnosed_on": "2016-10-26",
"id": 2,
"medical_condition_id": -19,
"notes": "",
"pet_id": 7
}
],
"microchip_ids": [
2
],
"microchip_nums": [
"856547458"
],
"name": "Allen",
"notes": "",
"owner_id": 57,
"pet_type_id": -1,
"price": "5000.00",
"received_by_client_at": "2016-10-26T10:30:41.697461-04:00",
"received_by_location_at": "2016-10-26T10:30:41.697461-04:00",
"registry_records": [
{
"deleted": false,
"id": 5,
"number": "",
"registry_id": -1
}
],
"sale_price": null,
"sold_price": "3750.0",
"status_id": -5,
"sub_status_id": -5,
"sub_status_updated_at": null,
"transaction_closed_at": "2020-09-29T14:22:43.975755-04:00",
"transaction_id": 1071,
"treatment_events": [
{
"daterange": "[2016-10-26,2016-10-26]",
"deleted": false,
"frequency": 1,
"id": 1,
"notes": "notes for this medication",
"pet_id": 7,
"treatment_id": 1
},
{
"daterange": "[2016-10-26,2016-10-29]",
"deleted": false,
"frequency": 1,
"id": 2,
"notes": "notes in here",
"pet_id": 7,
"treatment_id": 1
},
{
"daterange": "[2017-01-02,2017-01-03]",
"deleted": false,
"frequency": 2,
"id": 3,
"notes": "",
"pet_id": 7,
"treatment_id": 2
},
{
"daterange": "[2020-07-13,2020-07-13]",
"deleted": false,
"frequency": 1,
"id": 9,
"notes": null,
"pet_id": 7,
"treatment_id": 5
},
{
"daterange": "[2020-07-06,2020-07-06]",
"deleted": false,
"frequency": 1,
"id": 12,
"notes": null,
"pet_id": 7,
"treatment_id": 5
},
{
"daterange": "[2020-06-29,2020-06-29]",
"deleted": false,
"frequency": 1,
"id": 15,
"notes": null,
"pet_id": 7,
"treatment_id": 5
}
],
"weight": 3636,
"weighted_on": "2017-02-13",
"weights": [
{}
]
},
{
"band": null,
"breed": {
"aliases": [
"Affen",
"Monkey Dog"
],
"custom_fields": {
"Height": null,
"Weight": null
},
"deleted": false,
"description": "Loyal, curious, and famously amusing, this almost-human toy dog is fearless out of all proportion to his size. As with all great comedians, it\u2019s the Affenpinscher\u2019s apparent seriousness of purpose that makes his antics all the more amusing.",
"display_behavior": "Only if Available",
"display_name": "Affenpinscher",
"id": -1,
"is_temp": false,
"slug": "affenpinschers"
},
"breed_id": -1,
"changed_at": "2019-03-07T16:00:14.313631-05:00",
"color_markings": "brown with left white sock",
"cost": "250.00",
"currently_at_entity_id": 4,
"custom_fields": null,
"deceased_on": null,
"deleted": false,
"entity_id": 4,
"gender": "Female",
"id": 8,
"identifiers": "Litter 1",
"images": [
{
"deleted": false,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"file": {
"basename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13",
"checksum": [
241,
... removed additional values for example
104,
109
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"extension": "jpg",
"filename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13.jpg",
"id": 7144,
"stored_at": "2020-10-24T05:11:21.540515-04:00"
},
"id": 55,
"image": {
"dimensions": [
100,
100
],
"id": 7144
},
"sort_order": 0,
"tags": []
}
],
"imported_identifier": null,
"is_marketing_notes_enabled": null,
"litter": {
"age": "368 weeks",
"birthdate": "2016-10-20",
"deleted": false,
"id": 8,
"notes": "8 weeks"
},
"litter_id": 8,
"location": {
"attrs": null,
"deleted": false,
"entity": {
"address_1": "123 Main Street",
"address_2": "",
"attributes": {},
"businessname": "Pinogy Store",
"city": "Herndon",
"contact_numbers": {
"Office": "888-555-7381"
},
"created_at": "2015-12-09T12:59:15.033735-05:00",
"deleted": false,
"emails": {
"Office": "info@example.com"
},
"firstname": "",
"id": 4,
"is_active": true,
"iso_code": "VA",
"lastname": "",
"name": "Pinogy Store",
"notes": "",
"postal_code": "20170",
"region_fullname": "Virginia",
"role_ids": [
-2
],
"role_names": [
"Location"
],
"smart_search": "Pinogy Store Pinogy Store Location Herndon 123 Main Street Virginia VA 8885557381 888-555-7381 info@example.com Pinogy Store PS",
"sub_state": "",
"tax_exempt": false,
"updated_at": "2023-11-09T16:48:53.418141",
"url": ""
},
"id": 4,
"is_enabled": true,
"is_primary_store": true,
"is_public": true,
"latitude": null,
"logo": null,
"longitude": null,
"marketing_phone": null,
"max_safety_stock_days": 18,
"min_safety_stock_days": 18,
"open_hours": {
"Friday": [
"9:00 AM",
"9:00 PM"
],
"Monday": [
"9:00 AM",
"8:00 PM"
],
"Saturday": [
"9:00 AM",
"9:00 PM"
],
"Sunday": [
"11:00 AM",
"6:00 PM"
],
"Thursday": [
"9:00 AM",
"8:00 PM"
],
"Tuesday": [
"9:00 AM",
"8:00 PM"
],
"Wednesday": [
"9:00 AM",
"8:00 PM"
]
},
"pricing_group": {
"deleted": false,
"id": 1,
"name": "PrcGrp #1"
},
"receipt_name": "Pinogy Store",
"report_code": "PS",
"show_regional": true,
"slug": "pinogy-store",
"social_links": {
"Facebook": "https://facebook.com/example",
"Instagram": "https://instgram.com/mystore"
},
"updated_at": "2015-12-09T12:59:15.039683-05:00",
"website_url": "www.example.com"
},
"location_id": 4,
"marketing_notes": null,
"medical_condition_events": [],
"microchip_ids": null,
"microchip_nums": null,
"name": null,
"notes": "",
"owner_id": 157,
"pet_type_id": -1,
"price": "500.00",
"received_by_client_at": "2016-12-15T14:53:54.215946-05:00",
"received_by_location_at": "2016-12-15T14:53:54.215946-05:00",
"registry_records": [
{
"deleted": false,
"id": 6,
"number": "",
"registry_id": -1
}
],
"sale_price": "405.00",
"sold_price": "500.0",
"status_id": -5,
"sub_status_id": -5,
"sub_status_updated_at": null,
"transaction_closed_at": "2017-06-09T12:26:05.502260-04:00",
"transaction_id": 364,
"treatment_events": [],
"weight": 2272,
"weighted_on": "2016-12-15",
"weights": [
{}
]
}
],
"offset": 0,
"total": 111
} |
GET /api/pets/{pet_id} – gets a specific pet - GET /api/pets/8
Response
| Code Block | ||
|---|---|---|
| ||
{
"addons": [
{
"cost": "0.0",
"default_is_selected": true,
"deleted": false,
"id": 11,
"is_pinogy": false,
"is_required": true,
"name": "Food",
"price": "0.0",
"product_id": null,
"variation_id": 5
},
{
"cost": "32.99",
"default_is_selected": false,
"deleted": false,
"id": -7,
"is_pinogy": true,
"is_required": false,
"name": "LMP Better Enrollment Add On",
"price": "79.99",
"product_id": 19303,
"variation_id": null
}
],
"band": null,
"breed": {
"aliases": [
"Affen",
"Monkey Dog"
],
"custom_fields": {
"Height": null,
"Weight": null
},
"deleted": false,
"description": "Loyal, curious, and famously amusing, this almost-human toy dog is fearless out of all proportion to his size. As with all great comedians, it\u2019s the Affenpinscher\u2019s apparent seriousness of purpose that makes his antics all the more amusing.",
"display_behavior": "Only if Available",
"display_name": "Affenpinscher",
"id": -1,
"is_temp": false,
"slug": "affenpinschers"
},
"breed_id": -1,
"changed_at": "2019-03-07T16:00:14.313631-05:00",
"color_markings": "brown with left white sock",
"cost": "250.00",
"currently_at_entity_id": 4,
"custom_fields": null,
"deceased_on": null,
"deleted": false,
"entity_id": 4,
"gender": "Female",
"id": 8,
"identifiers": "Litter 1",
"images": [
{
"deleted": false,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"file": {
"basename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13",
"checksum": [
241,
... removed additional values for example
104,
109
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"extension": "jpg",
"filename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13.jpg",
"id": 7144,
"stored_at": "2020-10-24T05:11:21.540515-04:00"
},
"id": 55,
"image": {
"dimensions": [
100,
100
],
"id": 7144
},
"sort_order": 0,
"tags": []
}
],
"imported_identifier": null,
"is_marketing_notes_enabled": null,
"litter": {
"age": "368 weeks",
"birthdate": "2016-10-20",
"deleted": false,
"id": 8,
"notes": "8 weeks"
},
"litter_id": 8,
"location": {
"attrs": null,
"deleted": false,
"entity": {
"address_1": "123 Main Street",
"address_2": "",
"attributes": {},
"businessname": "Pinogy Store",
"city": "Herndon",
"contact_numbers": {
"Office": "888-555-7381"
},
"created_at": "2015-12-09T12:59:15.033735-05:00",
"deleted": false,
"emails": {
"Office": "info@example.com"
},
"firstname": "",
"id": 4,
"is_active": true,
"iso_code": "VA",
"lastname": "",
"name": "Pinogy Store",
"notes": "",
"postal_code": "20170",
"region_fullname": "Virginia",
"role_ids": [
-2
],
"role_names": [
"Location"
],
"smart_search": "Pinogy Store Pinogy Store Location Herndon 123 Main Street Virginia VA 8885557381 888-555-7381 info@example.com Pinogy Store PS",
"sub_state": "",
"tax_exempt": false,
"updated_at": "2023-11-09T16:48:53.418141",
"url": ""
},
"id": 4,
"is_enabled": true,
"is_primary_store": true,
"is_public": true,
"latitude": null,
"logo": null,
"longitude": null,
"marketing_phone": null,
"max_safety_stock_days": 18,
"min_safety_stock_days": 18,
"open_hours": {
"Friday": [
"9:00 AM",
"9:00 PM"
],
"Monday": [
"9:00 AM",
"8:00 PM"
],
"Saturday": [
"9:00 AM",
"9:00 PM"
],
"Sunday": [
"11:00 AM",
"6:00 PM"
],
"Thursday": [
"9:00 AM",
"8:00 PM"
],
"Tuesday": [
"9:00 AM",
"8:00 PM"
],
"Wednesday": [
"9:00 AM",
"8:00 PM"
]
},
"pricing_group": {
"deleted": false,
"id": 1,
"name": "PrcGrp #1"
},
"receipt_name": "Pinogy Store",
"report_code": "PS",
"show_regional": true,
"slug": "pinogy-store",
"social_links": {
"Facebook": "https://facebook.com/example",
"Instagram": "https://instgram.com/mystore"
},
"updated_at": "2015-12-09T12:59:15.039683-05:00",
"website_url": "www.example.com"
},
"location_id": 4,
"marketing_notes": null,
"medical_condition_events": [],
"microchip_ids": null,
"microchip_nums": null,
"name": null,
"notes": "",
"owner_id": 157,
"pet_type_id": -1,
"price": "500.00",
"received_by_client_at": "2016-12-15T14:53:54.215946-05:00",
"received_by_location_at": "2016-12-15T14:53:54.215946-05:00",
"registry_records": [
{
"deleted": false,
"id": 6,
"number": "",
"registry_id": -1
}
],
"sale_price": "405.00",
"sold_price": "500.0",
"status_id": -5,
"sub_status_id": -5,
"sub_status_updated_at": null,
"transaction_closed_at": "2017-06-09T12:26:05.502260-04:00",
"transaction_id": 364,
"treatment_events": [],
"weight": 2272,
"weighted_on": "2016-12-15",
"weights": [
{}
]
} |
GET /api/pets/{pet_id}/media – images and videos; videos paid feature add ons /api/pets/8/media
Response
| Code Block | ||
|---|---|---|
| ||
{
"count": 1,
"objects": [
{
"deleted": false,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"id": 55,
"image": {
"dimensions": [
100,
100
],
"file": {
"basename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13",
"checksum": [
241,
... removed additional values for example
104,
109
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"extension": "jpg",
"filename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13.jpg",
"id": 7144,
"stored_at": "2020-10-24T05:11:21.540515-04:00"
},
"id": 7144
},
"sort_order": 0,
"tags": [],
"type": "image"
}
],
"offset": 0,
"total": 1
} |
GET /api/pets/{pet_id}/images/{image_id} {'include_contents': 'true'} -
/api/pets/8/images/55 {'include_contents': 'true'}
Response
| Code Block | ||
|---|---|---|
| ||
{
"deleted": false,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"file": {
"basename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13",
"checksum": [
241,
... removed additional values for example
104,
109
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"extension": "jpg",
"filename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13.jpg",
"id": 7144,
"stored_at": "2020-10-24T05:11:21.540515-04:00"
},
"filedata": "/9j/4AAQSkZJRgABAQAASABIAAD/4QBYRXhpZgAATU0AKgAAAAgAAgESAAMAAAABAAEAAIdpAAQAAAABAAAAJgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAL0KADAAQAAAABAAAPvQAAAAD/7QA4UGhvdG9zaG9wIDMuMAA4QklNBAQAAAAAAAA4QklNBCUAAAAAABDUHYzZjwCyBOmACZjs+EJ+/8AAEQgPvQvQAwEiAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1t
... BASE64 ... removed for example
AHafa2Ukt7OGI+5uDehohKXui5uX3iXTnmi1aHUpCvnBGX5mwpzWTdaVI0huppl2795C9BVa6g0yfT4rq+dzdxyfMucLitSS6t/Mlhs4RNHLt2+y1NSlzGM5S5SJLu+Nw90x2Lu8tXx96izSzF99ojmKFEYO3TIb722opLi4jsXt7mbc27cqL2/3at3EVnqF0ki7hhFXKj5TWfs/eMo8vN7wC9jVHsrbiN+haoWnWxTyYUAeT5d3/s1QtGt9PG80g+zp8i/71atxZWdxILOVPnj9+ldy+E6iK2gR7gSzM16H+R1X09FrNjgWGaaO0VoJN5iiT+JEP8LVIttbafCyQSPHvbdvXotTAST3xuo5N8yL9/8Ahf8A3qznTLhL3uUL2OCza2aSPLbtrsnzbqz9Ti2zC+kRVK/Iqr/wDqNv8A481NgVV1t9IUDYDvDMMnNaN3cGx04TIoZ5GZQSPuj2raD6DnsMhN1ZpujiFzEi7S2M/NTLeXVpfMt4Csduq7jxzVRZLzRoFhtJch0JJYZ5HTvUVkbie7e7mkyTGAy44OPaonL3veI5veJrVdUvmWEfvSfu7vubVp7Pb308k1zujT7rbOSxX+6tWlkuJotkD+SFXPyjvVbS7a1NtJPeq07B/7xUZPfinPlsV7RH//2Q==",
"id": 55,
"image": {
"dimensions": [
100,
100
],
"file": {
"basename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13",
"checksum": [
241,
... removed additional values for example
104,
109
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "image_cropper_E6C7A792-CCA8-4FB5-BA18-305988956A01-524-00000022391C2F13.jpg",
"extension": "jpg",
"filename": "image_cropper_e6c7a792-cca8-4fb5-ba18-305988956a01-524-00000022391c2f13.jpg",
"id": 7144,
"stored_at": "2020-10-24T05:11:21.540515-04:00"
},
"id": 7144
},
"sort_order": 0,
"tags": []
} |
...