By utilizing the API, you are agreeing to the Pinogy API Service Agreement. If you would also like your application listed in Pinogy’s App Store, you will also need to agree to the Application Developer and API Agreement.
Please use the following documentation as a guide for your integration.
Developer Assistance
If you find yourself getting stuck at any point while trying to implement the api, email us at dev-support@pinogy.com.
Pinogy API
This first step to using Pinogy’s API is to be able to log in. Sample implementations are available for:
Python: https://bitbucket.org/pinogycorp/po_clients/src/master/python/
PHP: https://bitbucket.org/pinogycorp/po_clients/src/master/php/
C#: https://bitbucket.org/pinogycorp/po_clients/src/master/csharp/
In addition, you will need to obtain the api host, access key, secret key, and password for each client.
Common Parameters
Almost all resources can be called with the following parameters:
order_by: This will return the results sorted by the column you specify.
limit: Limit the number of results. If you do not send a
limitparameter the default limit is 100 records. The max limit is 1000 records (if you put limit=1001 or more, it will still return 1000 records so this is discouraged).offset: Get more results. You can send the offset parameter to start at a set record count. If you do not send an
offsetparameter the default is 0 for the first record.
Resources
The list of available resources and parameters is available below
Pets
GET /api/pets – gets all pets
GET /api/pets/{pet_id} – gets a specific pet
{
"addons": [
{
"cost": "0.00",
"deleted": false,
"id": -3,
"is_required": true,
"name": "AKC Reunite Enrollment",
"price": "0.00",
"product": {
"id": 20003,
"name": "AKC Reunite Enrollment "
},
"product_id": 20003
},
{
"cost": "0.00",
"deleted": false,
"id": -2,
"is_required": true,
"name": "AKC Pedigree Registration",
"price": "99.99",
"product": {
"id": 20002,
"name": "AKC Pedigree Registration "
},
"product_id": 20002
}
],
"band": "",
"breed": {
"aliases": [
"Rott",
"Rottie"
],
"custom_fields": {
"Height": "[36287,61235)",
"Weight": "[559,686)"
},
"deleted": false,
"description": "The Rottweiler is a robust working breed of great strength descended from the mastiffs of the Roman legions. A gentle playmate and protector within the family circle, the Rottie observes the outside world with a self-assured aloofness.",
"display_behavior": "Only if Available",
"display_name": "Rottweiler",
"id": -137,
"is_temp": false,
"slug": "rottweilers"
},
"changed_at": "2021-02-18T16:55:50.913462-05:00",
"color_markings": "Color / Markings",
"cost": "375.00",
"currently_at_entity_id": 7,
"custom_fields": null,
"deleted": false,
"gender": "Female",
"id": 4916,
"identifiers": "Identifiers",
"images": [
{
"deleted": false,
"description": "Female Rottweiler Puppy for sale",
"file": {
"basename": "male-or-female-rottie",
"checksum": [
144,
...
133
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "Female Rottweiler Puppy for sale",
"extension": "jpg",
"id": 16498,
"stored_at": "2021-02-18T16:55:07.462052-05:00"
},
"id": 6870,
"image": {
"id": 16498
},
"sort_order": 0,
"tags": null
},
{
"deleted": false,
"description": "Female Rottweiler Puppy for sale",
"file": {
"basename": "german-rottweiler-puppies-for-sale-females",
"checksum": [
141,
...
69
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "Female Rottweiler Puppy for sale",
"extension": "jpg",
"id": 16499,
"stored_at": "2021-02-18T16:55:21.200542-05:00"
},
"id": 6871,
"image": {
"id": 16499
},
"sort_order": 1,
"tags": null
},
{
"deleted": false,
"description": "Female Rottweiler Puppy for sale",
"file": {
"basename": "4889201_large-resize",
"checksum": [
36,
...
91
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "Female Rottweiler Puppy for sale",
"extension": "webp",
"id": 16500,
"stored_at": "2021-02-18T16:55:40.245084-05:00"
},
"id": 6872,
"image": {
"id": 16500
},
"sort_order": 2,
"tags": null
}
],
"imported_identifier": null,
"is_marketing_notes_enabled": null,
"location": {
"attrs": null,
"available_pets_count": 11,
"deleted": false,
"entity": {
"address_1": "100 Independence Way",
"address_2": "",
"attributes": {},
"businessname": "Foo Fighters - business",
"city": "Danvers",
"contact_numbers": {
"Office": "(101)557-3166"
},
"created_at": "2016-09-28T17:31:28.732279-04:00",
"deleted": false,
"emails": {
"Home": "FF1234@pinogy.com"
},
"firstname": "",
"id": 7,
"is_active": true,
"iso_code": "MA",
"lastname": "",
"name": "Foo Fighters - business",
"notes": "",
"postal_code": "01923",
"region_fullname": "Massachusetts",
"role_ids": [
-2
],
"role_names": [
"Location"
],
"smart_search": "Foo Fighters - business Foo Fighters - business Location Danvers 100 Independence Way Massachusetts MA 1015573166 (101)557-3166 FF1234@pinogy.com Foo Fighters - public FF 123123",
"sub_state": "",
"tax_exempt": false,
"url": ""
},
"id": 7,
"is_enabled": true,
"is_primary_store": false,
"is_public": true,
"latitude": "0",
"logo": null,
"longitude": "0",
"marketing_phone": null,
"max_safety_stock_days": 21,
"min_safety_stock_days": 7,
"open_hours": {
"Friday": [
"10:00 AM",
"9:00 PM"
],
"Monday": [
"10:00 AM",
"9:00 PM"
],
"Saturday": [
"10:00 AM",
"9:00 PM"
],
"Sunday": [
"11:00 AM",
"6:00 PM"
],
"Thursday": [
"10:00 AM",
"9:00 PM"
],
"Tuesday": [
"10:00 AM",
"9:00 PM"
],
"Wednesday": [
"10:00 AM",
"9:00 PM"
]
},
"pricing_group": {
"deleted": false,
"id": 1,
"name": "PrcGrp #1"
},
"receipt_name": "Foo Fighters - public",
"report_code": "FF",
"show_regional": true,
"slug": "foo-fighters-public",
"social_links": {},
"updated_at": "2016-09-28T17:31:28.732279-04:00",
"warehouse_location_ids": [
28267
],
"website_url": "www.foofighters.com"
},
"location_id": 7,
"marketing_notes": "",
"medical_condition_events": [
{
"diagnosed_on": "2021-02-16",
"id": 1213,
"medical_condition_id": -19,
"notes": "Cherry Eye Medical Condition"
}
],
"microchip_ids": [
4918
],
"microchip_nums": [
"999999999999999"
],
"name": "Christine",
"notes": "",
"price": "1000.00",
"received_by_client_at": "2021-02-18T16:47:51.476121-05:00",
"received_by_location_at": "2021-02-18T16:47:51.476121-05:00",
"registry_records": [
{
"id": 4781,
"number": "01",
"registry_id": -1
}
],
"sale_price": null,
"sold_price": null,
"transaction_closed_at": null,
"transaction_id": null,
"treatment_events": [
{
"daterange": "[2021-02-17,2021-02-18]",
"frequency": 2,
"id": 72717,
"notes": "Albon Metro Mix Treatment",
"treatment_id": 27
}
],
"weight": 2272,
"weighted_on": "2021-02-18",
"weights": [
{
"id": 3394,
"weighed_on": "2021-02-18",
"weight": 2272
},
{
"id": 3393,
"weighed_on": "2021-02-12",
"weight": 1818
},
{
"id": 3392,
"weighed_on": "2021-02-05",
"weight": 1363
}
]
}
GET /api/pets/{pet_id}/media – images and videos; videos paid feature add ons
{
"count": 3,
"objects": [
{
"deleted": false,
"description": "Female Rottweiler Puppy for sale",
"file": {
"basename": "german-rottweiler-puppies-for-sale-females",
"checksum": [
141,
...
69
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "Female Rottweiler Puppy for sale",
"extension": "jpg",
"id": 16499,
"stored_at": "2021-02-18T16:55:21.200542-05:00"
},
"id": 6871,
"image": {
"id": 16499
},
"pet": {
"id": 4916
},
"sort_order": 1,
"tags": null,
"type": "image"
},
{
"deleted": false,
"description": "Female Rottweiler Puppy for sale",
"file": {
"basename": "4889201_large-resize",
"checksum": [
36,
...
91
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "Female Rottweiler Puppy for sale",
"extension": "webp",
"id": 16500,
"stored_at": "2021-02-18T16:55:40.245084-05:00"
},
"id": 6872,
"image": {
"id": 16500
},
"pet": {
"id": 4916
},
"sort_order": 2,
"tags": null,
"type": "image"
},
{
"deleted": false,
"description": "Female Rottweiler Puppy for sale",
"file": {
"basename": "male-or-female-rottie",
"checksum": [
144,
...
133
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "Female Rottweiler Puppy for sale",
"extension": "jpg",
"id": 16498,
"stored_at": "2021-02-18T16:55:07.462052-05:00"
},
"id": 6870,
"image": {
"id": 16498
},
"pet": {
"id": 4916
},
"sort_order": 0,
"tags": null,
"type": "image"
}
],
"offset": 0,
"total": 3
}
GET /api/pet_breeds – gets all breeds
GET /api/pet_breeds/{breed_id} – gets a specific breed - Please note that you must mark any Pinogy generated content with Pinogy’s copyright.
{
"aliases": [
"Berner Sennenhund",
"Bernese Cattle Dog"
],
"badges": [
{
"deleted": false,
"file": {
"basename": "badge-family-dog",
"checksum": [
251,
...
75
],
"content_type": {
"extensions": [
"png"
],
"id": 16,
"name": "image/png"
},
"content_type_id": 16,
"description": "Family Badge",
"extension": "png",
"id": -556,
"stored_at": "2019-02-21T17:43:58.127732-05:00"
},
"id": -241,
"name": "Family Dog"
},
{
"deleted": false,
"file": {
"basename": "badge-guard-dog",
"checksum": [
20,
...
95
],
"content_type": {
"extensions": [
"png"
],
"id": 16,
"name": "image/png"
},
"content_type_id": 16,
"description": "Guard Dog Badge",
"extension": "png",
"id": -552,
"stored_at": "2019-02-20T06:54:04.602865-05:00"
},
"id": -239,
"name": "Guard Dog"
},
{
"deleted": false,
"file": {
"basename": "badge-akc-registrable",
"checksum": [
254,
...
185
],
"content_type": {
"extensions": [
"png"
],
"id": 16,
"name": "image/png"
},
"content_type_id": 16,
"description": "AKC Dog Badge",
"extension": "png",
"id": -555,
"stored_at": "2019-02-20T06:54:04.224467-05:00"
},
"id": -240,
"name": "AKC Registrable"
}
],
"custom_fields": {
"Height": "[31751,52163)",
"Weight": "[584,699)"
},
"deleted": false,
"description": "Big, powerful, and built for hard work, the Bernese Mountain Dog is also strikingly beautiful and blessed with a sweet, affectionate nature. Berners are generally placid but are always up for a romp with the owner, whom they live to please.",
"display_behavior": "Only if Available",
"display_name": "Bernese Mountain Dog",
"id": -25,
"images": [
{
"deleted": false,
"description": "",
"file": {
"basename": "shutterstock_557885086 (1)",
"checksum": [
53,
...
190
],
"content_type": {
"extensions": [
"jpg",
"jpeg",
"jpe",
"jfif"
],
"id": 15,
"name": "image/jpeg"
},
"content_type_id": 15,
"description": "",
"extension": "jpg",
"id": -260,
"stored_at": "2017-03-10T05:16:19.589197-05:00"
},
"id": -46,
"image": {
"id": -260
},
"sort_order": 100,
"tags": null
}
],
"is_temp": false,
"metrics": [
{
"deleted": false,
"id": -729,
"name": "Disposition",
"value": "4"
},
{
"deleted": false,
"id": -728,
"name": "Bark",
"value": "7"
},
{
"deleted": false,
"id": -727,
"name": "Trainability",
"value": "8"
},
{
"deleted": false,
"id": -726,
"name": "Energy",
"value": "8"
},
{
"deleted": false,
"id": -725,
"name": "Grooming",
"value": "6"
},
{
"deleted": false,
"id": -724,
"name": "Size",
"value": "3"
}
],
"notes": [
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Expression is intelligent, animated and gentle. The eyes are dark brown and slightly oval in shape with close-fitting eyelids. Inverted or everted eyelids are serious faults. Blue eye color is a disqualification. The ears are medium sized, set high, triangular in shape, gently rounded at the tip, and hang close to the head when in repose. When the Bernese Mountain Dog is alert, the ears are brought forward and raised at the base; the top of the ear is level with the top of the skull. The skull is flat on top and broad, with a slight furrow and a well-defined, but not exaggerated stop. The muzzle is strong and straight. The nose is always black. The lips are clean and, as the Bernese Mountain Dog is a dry-mouthed breed, the flews are only slightly developed. The teeth meet in a scissors bite. An overshot or undershot bite is a serious fault. Dentition is complete.",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Head",
"id": -1231,
"sort_index": 3
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The neck is strong, muscular and of medium length. The topline is level from the withers to the croup. The chest is deep and capacious with well-sprung, but not barrelshaped, ribs and brisket reaching at least to the elbows. The back is broad and firm. The loin is strong. The croup is broad and smoothly rounded to the tail insertion. The tail is bushy. It should be carried low when in repose. An upward swirl is permissible when the dog is alert, but the tail may never curl or be carried over the back. The bones in the tail should feel straight and should reach to the hock joint or below. A kink in the tail is a fault. ",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Neck, Topline, Body",
"id": -1232,
"sort_index": 4
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog is tri-colored. The ground color is jet black. The markings are rich rust and clear white. Symmetry of markings is desired. Rust appears over each eye, on the cheeks reaching to at least the corner of the mouth, on each side of the chest, on all four legs, and under the tail. There is a white blaze and muzzle band. A white marking on the chest typically forms an inverted cross. The tip of the tail is white. White on the feet is desired but must not extend higher than the pasterns. Markings other than described are to be faulted in direct relationship to the extent of the deviation. White legs or a white collar are serious faults. Any ground color other than black is a disqualification. ",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Color and Markings",
"id": -1233,
"sort_index": 8
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Blue eye color. Any ground color other than black",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Disqualifications",
"id": -1234,
"sort_index": 11
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Working",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Group",
"id": -3225,
"sort_index": 0
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog is a large, sturdy worker who can stand over 27 inches at the shoulder. The thick, silky, and moderately long coat is tricolored: jet black, clear white, and rust. The distinctive markings on the coat and face are breed hallmarks and, combined with the intelligent gleam in the dark eyes, add to the Berner\u2019s aura of majestic nobility. A hardy dog who thrives in cold weather, the Berner\u2019s brain and brawn helped him multitask on the farms and pastures of Switzerland. Berners get along with the entire family and are particularly gentle with children, but they will often become more attached to one lucky human. Berners are imposing but not threatening, and they maintain an aloof dignity with strangers.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "About",
"id": -3226,
"sort_index": 2
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog is one of four mountain-dog breeds who were long at home in the canton of Bern, a vast agricultural region vital to the dairy production required for two of Switzerland\u2019s most profitable exports: chocolate and cheese. Even today, Bern\u2019s website tells us, \u201cOver 12,000 farms are spread over the canton\u2019s valleys, hills, and mountain areas.\u201d Berners earned their keep by droving cattle, guarding farmyards from predators, and serving as gentle companions when the hard work of the day was done. Perhaps their greatest claim to working-dog fame is their ability to pull many times their own weight as drafting dogs, with their broad and muscular hindquarters generating immense strength. Despite the breed\u2019s great utility in the days before mechanized farming and ranching, by the late 1800s the Berner\u2019s numbers were dwindling and the quality of the surviving dogs left something to be desired. A painstaking effort was begun by Swiss fanciers to reverse the breed\u2019s decline. In 1907, a Swiss breed club was formed under the leadership of Professor Albert Heim, perhaps the most respected European dog man of his generation. Before long, Berners were once again a favored farm dog, and they also caught on as companions with Swiss householders. The breed\u2019s American history began in 1926, when a Kansas farmer imported a pair as all-around farm dogs. They caught on quickly, and the AKC registered its first Berner in 1937. Today, the Bernese Mountain Dog Club of America sponsors drafting and carting events that test the working ability of these majestic mountaineers.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "History",
"id": -3227,
"sort_index": 3
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog is a striking. tri-colored, large dog. He is sturdy and balanced. He is intelligent, strong and agile enough to do the draft and droving work for which he was used in the mountainous regions of his origin. Male dogs appear masculine, while bitches are distinctly feminine.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Standard",
"id": -3228,
"sort_index": 4
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog should do well on a high-quality dog food, whether commercially manufactured or home-prepared with your veterinarian\u2019s supervision and approval. Any diet should be appropriate to the dog\u2019s age (puppy, adult, or senior). Some dogs are prone to getting overweight, so watch your dog\u2019s calorie consumption and weight level. Treats can be an important aid in training, but giving too many can cause obesity. Learn about which human foods are safe for dogs, and which are not. Check with your vet if you have any concerns about your dog\u2019s weight or diet. Clean, fresh water should be available at all times.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Nutrition",
"id": -3229,
"sort_index": 5
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog has a double coat, with a longer outer coat and a wooly undercoat. Berners shed a fair amount, even more so during shedding season, which occurs twice a year. Weekly brushing\u2014daily during shedding season\u2014will help to remove loose hair and keep the dog looking his best. Any tangles can be worked out with a slicker brush or metal comb. As with all breeds, the nails should be trimmed regularly, as overly long nails can cause the dog pain and structural problems.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Grooming",
"id": -3230,
"sort_index": 6
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Bernese Mountain Dogs need at least a half-hour of moderate exercise every day to stay healthy and happy. While they are definitely meant to live indoors with their human family, Berners enjoy outdoor activities and make great companions on long walks or hikes. Outdoorsy owners often take their canine companions camping and backpacking. Berners enjoy pulling young children in a cart, and some even participate in carting and drafting competitions. Other canine sports in which Berners participate and excel include agility, herding, obedience, rally, and tracking.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Exercise",
"id": -3231,
"sort_index": 7
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Early socialization and obedience training are important for all dogs, but especially so for breeds as large as the Bernese Mountain Dog. Berners are intelligent and eager to please, so they are usually easy to train. They are also affectionate and openhearted; their feelings are easily hurt, and so they don\u2019t respond well to harsh corrections or training methods. A Berner wants to be with his family, and undesirable behaviors can result if he is regularly left alone for long periods of time.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Training",
"id": -3232,
"sort_index": 8
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Berners are generally healthy dogs, and responsible breeders will screen their breeding stock for health conditions such as hip and elbow dysplasia, blood disorders, some cancers, and progressive retinal atrophy. All large breeds are susceptible to bloat, a sudden, life-threatening stomach condition. Berner owners should learn what signs to look out for, and what to do should they occur. As with all breeds, a Berner\u2019s ears should be checked regularly for signs of infection, and the teeth should be brushed often, using a toothpaste designed for dogs.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Health",
"id": -3233,
"sort_index": 9
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog, called in Swiss German the Berner Sennenhund, is a large breed of dog, one of the four breeds of Sennenhund-type dogs from the Swiss Alps. They accompanied the alpine herders and dairymen. Originally kept as general farm dogs, large Sennenhunds in the past were also used as draft animals, pulling carts.",
"file": null,
"group": {
"id": -1,
"name": "Overview"
},
"header": "Overview",
"id": -125,
"sort_index": 1
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Measured at the withers, dogs are 25 to 27\u00bd inches; bitches are 23 to 26 inches. Though appearing square, Bernese Mountain Dogs are slightly longer in body than they are tall. Sturdy bone is of great importance. The body is full. undershot bite is a serious fault. Dentition is complete.",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Size, Proportion, Substance",
"id": -126,
"sort_index": 2
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The natural working gait of the Bernese Mountain Dog is a slow trot. However, in keeping with his use in draft and droving work, he is capable of speed and agility. There is good reach in front. Powerful drive from the rear is transmitted through a level back. There is no wasted action. Front and rear legs on each side follow through in the same plane. At increased speed, legs tend to converge toward the center line.",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Gait",
"id": -129,
"sort_index": 9
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": " The Bernese is one of four varieties of Swiss Mountain Dog. The Bernese is known in native land as Berner Sennenhund. The Bernese shares similar distinctive coloring with the other varieties of Swiss Mountain Dog, but it is the only one of the four to have a long, silky coat. The Bernese worked as drovers and draft dogs as well as watchdogs in the farmyards, mainly in the Canton of Berne, Switzerland. The ancestors of the Bernese dogs were brought into Switzerland over two thousand years ago by the invading Roman soldiers. Until a few years before WWI, the Bernese had been almost forgotten by all save the oldest inhabitants of Berne, when the breed had become practically unrecognizable. It was not until 1892 that the Swiss fancier Franz Schertenleib attempted to find good specimens to be used as breeding stock. ",
"file": null,
"group": {
"id": -4,
"name": "Trivia"
},
"header": "Did you know?",
"id": -130,
"sort_index": 10
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The coat is thick, moderately long and slightly wavy or straight. It has a bright natural sheen. Extremely curly or extremely dull-looking coats are undesirable. The Bernese Mountain Dog is shown in natural coat and undue trimming is to be discouraged.",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Coat",
"id": -132,
"sort_index": 7
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The shoulders are moderately laid back, flat-lying, well-muscled and never loose. The legs are straight and strong and the elbows are well under the shoulder when the dog is standing. The pasterns slope very slightly. but are never weak. Dewclaws may be removed. The feet are round and compact with well-arched toes.",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Forequarters",
"id": -133,
"sort_index": 5
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Good-Natured, Calm, Strong",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Temperament",
"id": -137,
"sort_index": 10
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "Farm dogs by heritage, Berners need a moderate amount of exercise as well as consistent obedience training. As a double-coated breed, they also tend to shed, and so require regular brushing. Their gentle, easygoing manner and the need to be close to their people makes them a good fit for families.",
"file": null,
"group": {
"id": -2,
"name": "Breed Info"
},
"header": "Right Breed for You?",
"id": -135,
"sort_index": 11
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The thighs are broad, strong and muscular. The stifles are moderately bent and taper smoothly into the hocks. The hocks are well let down and straight as viewed from the rear. Dewclaws should be removed. Feet are compact and turn neither in nor out.",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "Hindquarters",
"id": -136,
"sort_index": 12
},
{
"breed": {
"id": -25
},
"deleted": false,
"description": "The Bernese Mountain Dog is a striking. tri-colored, large dog. He is sturdy and balanced. He is intelligent, strong and agile enough to do the draft and droving work for which he was used in the mountainous regions of his origin. Dogs appear masculine, while bitches are distinctly feminine.",
"file": null,
"group": {
"id": -3,
"name": "Breed Standard"
},
"header": "General Appearance",
"id": -138,
"sort_index": 1
}
],
"pet_type": {
"available_pets_count": 56,
"deleted": false,
"has_litters": true,
"id": -1,
"is_enabled": true,
"name": "Puppy",
"plurals": {
"Canine": "Canines",
"Dog": "Dogs",
"Puppy": "Puppies"
},
"slug": "puppies",
"uses_band": false
},
"slug": "bernese-mountain-dogs"
}
Leads
GET /api/leads – get all leads
GET /api/leads/{lead_id} – gets a specific lead
{
"address": null,
"business_name": null,
"claimed_by_user_id": null,
"deleted": false,
"emails": [
"test@pinogy.com"
],
"entity_id": null,
"first_name": null,
"id": 329,
"last_name": null,
"phones": [
"0996226198"
],
"source": {
"deleted": false,
"id": -3,
"name": "Website"
},
"source_id": -3,
"stage": "New",
"website": null
}
GET /api/lead_conversations
GET /api/lead_conversations/{id}
{
"contacted_at": "2021-03-17T10:26:18.192576-04:00",
"data": {
"source_data": {
"email": "test@pinogy.com",
"firstname": "TestFirstName",
"form": "contact",
"form_plugin_id": 29879,
"language": "en",
"lastname": "TestLastName",
"location_id": "4",
"message": "TestMessage",
"phone": "1234657890"
}
},
"form": "contact",
"id": 329,
"lead": {
"address": null,
"business_name": null,
"emails": [
"test@pinogy.com"
],
"first_name": null,
"id": 331,
"last_name": null,
"phones": [
"1234657890"
],
"source": {
"id": -3,
"name": "Website"
},
"stage": "New",
"website": null
},
"location_id": 4
}
Please be aware that based on your access level, specific permissions, and agreements, access to certain resources may not be available.
Limits on API Usage
Currently there are two usage-based restrictions imposed while using the API. Normal use of the API should not hit either of these, but they are listed below to make sure you are aware of them.
Files in our system get a unique id. If the file is ever changed, then a new id is created, and if appropriate, the old file and referenced id is deleted. Because of this, files (which includes images) should only be pulled once, and then cached locally within your site, server, or application.
The number of sessions allowed on one device or login is limited. Sessions should be reused, instead of having a new session created for every request. The only time a new session needs to be created is if you receive a 409 response from the API. In that scenario, the old session has expired or has been terminated. A new session should be created (programmatically) , and then the request should be resubmitted.
Error Responses
Error HTTP code of an error response could be one of the following:
HTTP Code | Name | Description |
400 | Bad request | Any other handled exception |
401 | Unauthorized | Access token / credentials are missing or incorrect |
403 | Forbidden | Permission denied |
404 | Not found | Resource doesn’t exist |
406 | Not Acceptable | Login is incorrect or the application is not accessible |
409 | Conflict | Request is correct, but can’t be applied because of the server state constraints |
422 | Validation Error | There is an error in the values passed in |
500 | Internal server error | Unhandled exception happens on server side |