latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Pet Parents

List all PetParents

Permissions needed: NONE Returns a filtered & ordered list of all pet parents

get/api/v1/pet-parents

Query parameters

includestring[]

Additional relations to include

filter[has_app]boolean

If the pet parent has the app downloaded or not

filter[phone]string

Partial phone filter

filter[email]string

Filter by email address

filter[belongs_to_clinic]integer[]

Filter only by the pet parent that are associated to specific clinics. Default to current active clinic if omitted

[
  1
]
add_address_metadatainteger

Set to 1 to get the full address details

filter[updated_from]string date-time

Updated after the datetime (use iso8601 format - 2020-08-16T08:56:44.000000Z). Updated at and created at are returned in UTC in the response

filter[updated_to]string date-time

Updated at less or equal than the datetime (use iso8601 format - 2020-08-16T08:56:44.000000Z). Updated at and created at are returned in UTC in the response

filter[query]string

Search by name, last name, email.

Parameters

#/paths/~1api~1v1~1tags/get/parameters/5 — unresolved $ref

Response

Successful operation

dataData[] — unresolved $ref
linksLinks — unresolved $ref
metaMeta — unresolved $ref