Get a list of pet parents

1 min

GET

/api/v1/pet-parents

Returns a filtered & ordered list of all pet parents

Query Parameters

includesstring[]
Description
Which relationships should be included in the response
filter[has_app]boolean
Description
If the pet parent has the app downloaded or not
filter[phone]string
Description
Partial phone filter
filter[email]string
Description
Filter by email address
filter[belongs_to_clinic]integer
Description
Filter only by the pet parent that are associated to a specific clinic's id
add_address_metadatainteger
Description
Set to 1 to get the full address details
filter[updated_from]string<date-time>
Description
Updated after the datetime (use iso8601 format - 2020-08-16T08:56
.000000Z). Updated at and created at are returned in UTC in the response
filter[updated_to]string<date-time>
Description
Updated at less or equal than the datetime (use iso8601 format - 2020-08-16T08:56
.000000Z). Updated at and created at are returned in UTC in the response

Responses

200Successful operation

object
- dataPetParent[]
  - idinteger
    Example
    1
  - namestring
    Example
    John
  - last_namestring
    Example
    Doe
  - emailstring
    Example
    [email protected]
  - phonestring
    Example
    +19772480544
    Description
    In E164 format
  - secondary_phonestring
    Example
    +19772480544
    Description
    In E164 format
  - chatUidstring
    Example
    cjfiem-c9hg-apzm-23sod
  - has_appboolean
    Example
    true
  - has_app_datestring
    Example
    2020-06-12 15:45:43
  - enable_chat_without_appboolean
  - created_atstring<date-time>
    Example
    2020-06-12 15:45:43
  - updated_atstring<date-time>
    Example
    2020-06-12 15:45:43
  - addressstring
    Example
    Flowers St. 300, Palo Alto, 123456, USA
  - address_2string
  - citystring
    Example
    Buenos Aires
  - birthdatestring<date>
    Example
    1990-04-04
  - observationsstring
    Example
    happy
  - cnpstring
    Example
    1234567890123
  - chip_numberstring
    Example
    99281028
  - discountsDiscount[]
    - idinteger
      Example
      10
    - namestring
      Example
      digitail disc10
    - descriptionstring
      Example
      digitail disc10
    - discountinteger
      Example
      10
    - discount_typeinteger
      Description
      `0` - fixed `1` - percentage
    - enabledboolean
      Example
      true
  - address_meta_dataobject
    - zip_codestring
      Example
      123456
    - citystring
      Example
      Palo Alto
    - streetstring
      Example
      Flowers St.
    - street_numberstring
      Example
      1990
    - regionstring
      Example
      California
    - region_short_codestring
      Example
      CA
    - country_idinteger
      Example
      6
    - latitudestring
      Example
      37.4419
    - longitudestring
      Example
      122.1430
    - address_2string
  - current_client_idinteger
    Example
    30
- linkslinks
- metameta

curl

curl --request GET \
     --url /api/v1/pet-parents \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/api/v1/pet-parents", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/api/v1/pet-parents")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/api/v1/pet-parents"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful operation
{
  "data": [
    {
      "id": 1,
      "name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "phone": "+19772480544",
      "secondary_phone": "+19772480544",
      "chatUid": "cjfiem-c9hg-apzm-23sod",
      "has_app": true,
      "has_app_date": "2020-06-12 15:45:43",
      "enable_chat_without_app": false,
      "created_at": "2020-06-12 15:45:43",
      "updated_at": "2020-06-12 15:45:43",
      "address": "Flowers St. 300, Palo Alto, 123456, USA",
      "address_2": "",
      "city": "Buenos Aires",
      "birthdate": "1990-04-04",
      "observations": "happy",
      "cnp": "1234567890123",
      "chip_number": "99281028",
      "discounts": [
        {
          "id": 10,
          "name": "digitail disc10",
          "description": "digitail disc10",
          "discount": 10,
          "discount_type": 0,
          "enabled": true
        }
      ],
      "address_meta_data": {
        "zip_code": "123456",
        "city": "Palo Alto",
        "street": "Flowers St.",
        "street_number": "1990",
        "region": "California",
        "region_short_code": "CA",
        "country_id": 6,
        "latitude": "37.4419",
        "longitude": "122.1430",
        "address_2": ""
      },
      "current_client_id": 30
    }
  ],
  "links": {},
  "meta": {}
}