RescueGroups (Independent Publisher) (Preview)
Since 2002, RescueGroups.org has provided animal welfare organizations with easy to use, free and low-cost services like the Pet Adoption Portal to help maximize animal adoptions.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://rescuegroups.org/ |
| Privacy policy | https://rescuegroups.org/privacy-statement/ |
| Categories | Lifestyle and Entertainment |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get animal by ID |
Retrieves an animal's information by identifier. |
| Get animals |
Retrieve a list of animals. |
| Get animals at organization |
Retrieve a list of animals at an organization. |
| Get animals at organization by status |
Retrieves a list of animals at an organization by status. |
| Get animals by status |
Retrieves a list of animals by status. |
| Get breed by ID |
Retrieves the breed information by identifier. |
| Get breeds |
Retrieves a list of breeds. |
| Get breeds by species |
Retrieves a list of breeds by species. |
| Get breeds by species ID |
Retrieves a list of breeds by species identifier. |
| Get organization by ID |
Retrieve an organization by identifier. |
| Get organizations |
Retrieves a list of organizations |
Get animal by ID
Retrieves an animal's information by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Identifier
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Is Adoption Pending
|
data.attributes.isAdoptionPending | boolean |
Whether adoption is pending. |
|
Age Group
|
data.attributes.ageGroup | string |
The age group. |
|
Age
|
data.attributes.ageString | string |
The age. |
|
Birth Date
|
data.attributes.birthDate | string |
The birth date. |
|
Is Birth Date Exact
|
data.attributes.isBirthDateExact | boolean |
Whether birth date is exact. |
|
Breed
|
data.attributes.breedString | string |
The breed. |
|
Breed Primary
|
data.attributes.breedPrimary | string |
The primary breed. |
|
Breed Primary ID
|
data.attributes.breedPrimaryId | integer |
The primary breed identifier. |
|
Breed Secondary
|
data.attributes.breedSecondary | string |
The secondary breed. |
|
Breed Secondary ID
|
data.attributes.breedSecondaryId | integer |
The secondary breed identifier. |
|
Coat Length
|
data.attributes.coatLength | string |
The coat length. |
|
Is Courtesy Listing
|
data.attributes.isCourtesyListing | boolean |
Whether listing is courtesy. |
|
Description Html
|
data.attributes.descriptionHtml | string |
The description in HTML. |
|
Description Text
|
data.attributes.descriptionText | string |
The description text. |
|
Is Needing Foster
|
data.attributes.isNeedingFoster | boolean |
Whether is needing foster. |
|
Is Found
|
data.attributes.isFound | boolean |
Whether was found. |
|
Priority
|
data.attributes.priority | integer |
The priority. |
|
Name
|
data.attributes.name | string |
The name. |
|
Picture Count
|
data.attributes.pictureCount | integer |
The picture count. |
|
Picture Thumbnail URL
|
data.attributes.pictureThumbnailUrl | string |
The thumbnail picture URL address. |
|
Rescue ID
|
data.attributes.rescueId | string |
The rescue identifier. |
|
Search String
|
data.attributes.searchString | string |
The search string. |
|
Sex
|
data.attributes.sex | string |
The sex. |
|
Size Current
|
data.attributes.sizeCurrent | float |
The current size. |
|
Size UOM
|
data.attributes.sizeUOM | string |
The size unit of measurement. |
|
Slug
|
data.attributes.slug | string |
The slug. |
|
Is Sponsorable
|
data.attributes.isSponsorable | boolean |
Whether is sponsorable. |
|
Tracker Image URL
|
data.attributes.trackerimageUrl | string |
The tracker image URL address. |
|
Video Count
|
data.attributes.videoCount | integer |
The video count. |
|
Video URL Count
|
data.attributes.videoUrlCount | integer |
The video URL count. |
|
Created Date
|
data.attributes.createdDate | string |
The date created. |
|
Updated Date
|
data.attributes.updatedDate | string |
When updated date. |
|
Data
|
data.relationships.breeds.data | array of object | |
|
Type
|
data.relationships.breeds.data.type | string |
The type. |
|
ID
|
data.relationships.breeds.data.id | string |
The identifier. |
|
Data
|
data.relationships.colors.data | array of object | |
|
Type
|
data.relationships.colors.data.type | string |
The type. |
|
ID
|
data.relationships.colors.data.id | string |
The identifier. |
|
Data
|
data.relationships.patterns.data | array of object | |
|
Type
|
data.relationships.patterns.data.type | string |
The type. |
|
ID
|
data.relationships.patterns.data.id | string |
The identifier. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Data
|
data.relationships.statuses.data | array of object | |
|
Type
|
data.relationships.statuses.data.type | string |
The type. |
|
ID
|
data.relationships.statuses.data.id | string |
The identifier. |
|
Data
|
data.relationships.locations.data | array of object | |
|
Type
|
data.relationships.locations.data.type | string |
The type. |
|
ID
|
data.relationships.locations.data.id | string |
The identifier. |
|
Data
|
data.relationships.orgs.data | array of object | |
|
Type
|
data.relationships.orgs.data.type | string |
The type. |
|
ID
|
data.relationships.orgs.data.id | string |
The identifier. |
|
Data
|
data.relationships.pictures.data | array of object | |
|
Type
|
data.relationships.pictures.data.type | string |
The type. |
|
ID
|
data.relationships.pictures.data.id | string |
The identifier. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Name
|
included.attributes.name | string |
The name. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Description
|
included.attributes.description | string |
The description. |
|
Street
|
included.attributes.street | string |
The street. |
|
City
|
included.attributes.city | string |
The city. |
|
State
|
included.attributes.state | string |
The state. |
|
City/State
|
included.attributes.citystate | string |
The city and state. |
|
Postal Code
|
included.attributes.postalcode | string |
The postal code. |
|
Country
|
included.attributes.country | string |
The country. |
|
Phone
|
included.attributes.phone | string |
The phone. |
|
Lat
|
included.attributes.lat | float |
The latitude. |
|
Lon
|
included.attributes.lon | float |
The longitude. |
|
Coordinates
|
included.attributes.coordinates | string |
The coordinates. |
|
Email
|
included.attributes.email | string |
The email address. |
|
URL
|
included.attributes.url | string |
The URL address. |
|
Facebook URL
|
included.attributes.facebookUrl | string |
The Facebook URL address. |
|
Adoption Process
|
included.attributes.adoptionProcess | string |
The adoption process. |
|
About
|
included.attributes.about | string |
The about. |
|
Services
|
included.attributes.services | string |
The services. |
|
Type
|
included.attributes.type | string |
The type. |
|
File Size
|
included.attributes.original.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.original.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.original.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.original.url | string |
The URL address. |
|
File Size
|
included.attributes.large.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.large.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.large.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.large.url | string |
The URL address. |
|
File Size
|
included.attributes.small.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.small.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.small.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.small.url | string |
The URL address. |
|
Order
|
included.attributes.order | integer |
The order. |
|
Created
|
included.attributes.created | string |
When created. |
|
Updated
|
included.attributes.updated | string |
When updated. |
|
Self
|
included.links.self | string |
The self. |
Get animals
Retrieve a list of animals.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Adopted Date
|
data.attributes.adoptedDate | string |
The adoption date. |
|
Is Adoption Pending
|
data.attributes.isAdoptionPending | boolean |
Whether adoption is pending. |
|
Age Group
|
data.attributes.ageGroup | string |
The age group. |
|
Age
|
data.attributes.ageString | string |
The age. |
|
Birth Date
|
data.attributes.birthDate | string |
The birth date. |
|
Is Birth Date Exact
|
data.attributes.isBirthDateExact | boolean |
Whether birth date is exact. |
|
Breed
|
data.attributes.breedString | string |
The breed. |
|
Breed Primary
|
data.attributes.breedPrimary | string |
The primary breed. |
|
Breed Primary ID
|
data.attributes.breedPrimaryId | integer |
The primary breed identifier. |
|
Breed Secondary
|
data.attributes.breedSecondary | string |
The secondary breed. |
|
Breed Secondary ID
|
data.attributes.breedSecondaryId | integer |
The secondary breed identifier. |
|
Color Details
|
data.attributes.colorDetails | string |
The color details. |
|
Is Courtesy Listing
|
data.attributes.isCourtesyListing | boolean |
Whether listing is courtesy. |
|
Description Html
|
data.attributes.descriptionHtml | string |
The description in HTML. |
|
Description Text
|
data.attributes.descriptionText | string |
The description text. |
|
Is Needing Foster
|
data.attributes.isNeedingFoster | boolean |
Whether is needing foster. |
|
Is Found
|
data.attributes.isFound | boolean |
Whether was found. |
|
Priority
|
data.attributes.priority | integer |
The priority. |
|
Name
|
data.attributes.name | string |
The name. |
|
Picture Count
|
data.attributes.pictureCount | integer |
The picture count. |
|
Picture Thumbnail URL
|
data.attributes.pictureThumbnailUrl | string |
The thumbnail picture URL address. |
|
Search String
|
data.attributes.searchString | string |
The search string. |
|
Sex
|
data.attributes.sex | string |
The sex. |
|
Size UOM
|
data.attributes.sizeUOM | string |
The size unit of measurement. |
|
Slug
|
data.attributes.slug | string |
The slug. |
|
Is Sponsorable
|
data.attributes.isSponsorable | boolean |
Whether is sponsorable. |
|
Tracker Image URL
|
data.attributes.trackerimageUrl | string |
The tracker image URL address. |
|
URL
|
data.attributes.url | string |
The URL address. |
|
Video Count
|
data.attributes.videoCount | integer |
The video count. |
|
Video URL Count
|
data.attributes.videoUrlCount | integer |
The video URL count. |
|
Created Date
|
data.attributes.createdDate | string |
The date created. |
|
Updated Date
|
data.attributes.updatedDate | string |
When updated date. |
|
Activity Level
|
data.attributes.activityLevel | string |
The activity level. |
|
Adoption Fee
|
data.attributes.adoptionFeeString | string |
The adoption fee. |
|
Is Breed Mixed
|
data.attributes.isBreedMixed | boolean |
Whether is a mixed breed. |
|
Is Cats Ok
|
data.attributes.isCatsOk | boolean |
Whether is okay with cats. |
|
Coat Length
|
data.attributes.coatLength | string |
The coat length. |
|
Is Current Vaccinations
|
data.attributes.isCurrentVaccinations | boolean |
Whether is current with vaccinations. |
|
Is Dogs Ok
|
data.attributes.isDogsOk | boolean |
Whether is okay with dogs. |
|
Is Kids Ok
|
data.attributes.isKidsOk | boolean |
Whether is okay with kids. |
|
New People Reaction
|
data.attributes.newPeopleReaction | string |
The reaction with new people. |
|
Owner Experience
|
data.attributes.ownerExperience | string |
The previous owner experience. |
|
Size Current
|
data.attributes.sizeCurrent | float |
The current size. |
|
Size Group
|
data.attributes.sizeGroup | string |
The group size. |
|
Size Potential
|
data.attributes.sizePotential | integer |
The potential size. |
|
Is Special Needs
|
data.attributes.isSpecialNeeds | boolean |
Whether is special needs. |
|
Available Date
|
data.attributes.availableDate | string |
The date available. |
|
Is House-trained
|
data.attributes.isHousetrained | boolean |
Whether is house-trained. |
|
Rescue ID
|
data.attributes.rescueId | string |
The rescue identifier. |
|
Adult Sexes Ok
|
data.attributes.adultSexesOk | string |
The adult sexes okay with. |
|
Energy Level
|
data.attributes.energyLevel | string |
The energy level. |
|
Fence Needs
|
data.attributes.fenceNeeds | string |
The fence needs. |
|
Grooming Needs
|
data.attributes.groomingNeeds | string |
The grooming needs. |
|
Obedience Training
|
data.attributes.obedienceTraining | string |
The obedience training. |
|
Qualities
|
data.attributes.qualities | array of string |
The qualities. |
|
Vocal Level
|
data.attributes.vocalLevel | string |
The vocal level. |
|
Is Yard Required
|
data.attributes.isYardRequired | boolean |
Whether yard is required. |
|
Special Needs Details
|
data.attributes.specialNeedsDetails | string |
The special needs details. |
|
Exercise Needs
|
data.attributes.exerciseNeeds | string |
The exercise needs. |
|
Indoor Outdoor
|
data.attributes.indoorOutdoor | string |
The indoor and outdoor preference. |
|
Shedding Level
|
data.attributes.sheddingLevel | string |
The shedding level. |
|
Summary
|
data.attributes.summary | string |
The summary. |
|
Is Declawed
|
data.attributes.isDeclawed | boolean |
Whether is declawed. |
|
Ear Type
|
data.attributes.earType | string |
The ear type. |
|
Eye Color
|
data.attributes.eyeColor | string |
The eye color. |
|
Tail Type
|
data.attributes.tailType | string |
The tail type. |
|
Kill Reason
|
data.attributes.killReason | string |
The kill reason. |
|
Data
|
data.relationships.breeds.data | array of object | |
|
Type
|
data.relationships.breeds.data.type | string |
The type. |
|
ID
|
data.relationships.breeds.data.id | string |
The identifier. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Data
|
data.relationships.statuses.data | array of object | |
|
Type
|
data.relationships.statuses.data.type | string |
The type. |
|
ID
|
data.relationships.statuses.data.id | string |
The identifier. |
|
Data
|
data.relationships.locations.data | array of object | |
|
Type
|
data.relationships.locations.data.type | string |
The type. |
|
ID
|
data.relationships.locations.data.id | string |
The identifier. |
|
Data
|
data.relationships.orgs.data | array of object | |
|
Type
|
data.relationships.orgs.data.type | string |
The type. |
|
ID
|
data.relationships.orgs.data.id | string |
The identifier. |
|
Data
|
data.relationships.pictures.data | array of object | |
|
Type
|
data.relationships.pictures.data.type | string |
The type. |
|
ID
|
data.relationships.pictures.data.id | string |
The identifier. |
|
Data
|
data.relationships.colors.data | array of object | |
|
Type
|
data.relationships.colors.data.type | string |
The type. |
|
ID
|
data.relationships.colors.data.id | string |
The identifier. |
|
Data
|
data.relationships.videourls.data | array of object | |
|
Type
|
data.relationships.videourls.data.type | string |
The type. |
|
ID
|
data.relationships.videourls.data.id | string |
The identifier. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Name
|
included.attributes.name | string |
The name. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Description
|
included.attributes.description | string |
The description. |
|
Street
|
included.attributes.street | string |
The street. |
|
City
|
included.attributes.city | string |
The city. |
|
State
|
included.attributes.state | string |
The state. |
|
City/State
|
included.attributes.citystate | string |
The city and state. |
|
Postal Code
|
included.attributes.postalcode | string |
The postal code. |
|
Country
|
included.attributes.country | string |
The country. |
|
Phone
|
included.attributes.phone | string |
The phone. |
|
Lat
|
included.attributes.lat | float |
The latitude. |
|
Lon
|
included.attributes.lon | float |
The longitude. |
|
Coordinates
|
included.attributes.coordinates | string |
The coordinates. |
|
Email
|
included.attributes.email | string |
The email address. |
|
URL
|
included.attributes.url | string |
The URL address. |
|
Facebook URL
|
included.attributes.facebookUrl | string |
The Facebook URL address. |
|
Type
|
included.attributes.type | string |
The type. |
|
File Size
|
included.attributes.original.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.original.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.original.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.original.url | string |
The URL address. |
|
File Size
|
included.attributes.large.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.large.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.large.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.large.url | string |
The URL address. |
|
File Size
|
included.attributes.small.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.small.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.small.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.small.url | string |
The URL address. |
|
Order
|
included.attributes.order | integer |
The order. |
|
Created
|
included.attributes.created | string |
When created. |
|
Updated
|
included.attributes.updated | string |
When updated. |
|
Services
|
included.attributes.services | string |
The services. |
|
Adoption Process
|
included.attributes.adoptionProcess | string |
The adoption process. |
|
About
|
included.attributes.about | string |
The about. |
|
Adoption URL
|
included.attributes.adoptionUrl | string |
The adoption URL address. |
|
Donation URL
|
included.attributes.donationUrl | string |
The donation URL address. |
|
Video ID
|
included.attributes.videoId | string |
The video identifier. |
|
URL Thumbnail
|
included.attributes.urlThumbnail | string |
The thumbnail URL address. |
|
Self
|
included.links.self | string |
The self. |
Get animals at organization
Retrieve a list of animals at an organization.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Identifier
|
id | True | string |
The identifier. |
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Activity Level
|
data.attributes.activityLevel | string |
The activity level. |
|
Is Adoption Pending
|
data.attributes.isAdoptionPending | boolean |
Whether adoption is pending. |
|
Age
|
data.attributes.ageString | string |
The age. |
|
Birth Date
|
data.attributes.birthDate | string |
The birth date. |
|
Is Birth Date Exact
|
data.attributes.isBirthDateExact | boolean |
Whether birth date is exact. |
|
Breed
|
data.attributes.breedString | string |
The breed. |
|
Breed Primary
|
data.attributes.breedPrimary | string |
The primary breed. |
|
Breed Primary ID
|
data.attributes.breedPrimaryId | integer |
The primary breed identifier. |
|
Is Breed Mixed
|
data.attributes.isBreedMixed | boolean |
Whether is a mixed breed. |
|
Is Cats Ok
|
data.attributes.isCatsOk | boolean |
Whether is okay with cats. |
|
Coat Length
|
data.attributes.coatLength | string |
The coat length. |
|
Color Details
|
data.attributes.colorDetails | string |
The color details. |
|
Is Courtesy Listing
|
data.attributes.isCourtesyListing | boolean |
Whether listing is courtesy. |
|
Is Current Vaccinations
|
data.attributes.isCurrentVaccinations | boolean |
Whether is current with vaccinations. |
|
Is Declawed
|
data.attributes.isDeclawed | boolean |
Whether is declawed. |
|
Description Html
|
data.attributes.descriptionHtml | string |
The description in HTML. |
|
Description Text
|
data.attributes.descriptionText | string |
The description text. |
|
Is Needing Foster
|
data.attributes.isNeedingFoster | boolean |
Whether is needing foster. |
|
Is Found
|
data.attributes.isFound | boolean |
Whether was found. |
|
Priority
|
data.attributes.priority | integer |
The priority. |
|
Indoor Outdoor
|
data.attributes.indoorOutdoor | string |
The indoor and outdoor preference. |
|
Name
|
data.attributes.name | string |
The name. |
|
New People Reaction
|
data.attributes.newPeopleReaction | string |
The reaction with new people. |
|
Owner Experience
|
data.attributes.ownerExperience | string |
The previous owner experience. |
|
Picture Count
|
data.attributes.pictureCount | integer |
The picture count. |
|
Picture Thumbnail URL
|
data.attributes.pictureThumbnailUrl | string |
The thumbnail picture URL address. |
|
Search String
|
data.attributes.searchString | string |
The search string. |
|
Sex
|
data.attributes.sex | string |
The sex. |
|
Size Group
|
data.attributes.sizeGroup | string |
The group size. |
|
Size UOM
|
data.attributes.sizeUOM | string |
The size unit of measurement. |
|
Slug
|
data.attributes.slug | string |
The slug. |
|
Is Special Needs
|
data.attributes.isSpecialNeeds | boolean |
Whether is special needs. |
|
Is Sponsorable
|
data.attributes.isSponsorable | boolean |
Whether is sponsorable. |
|
Tracker Image URL
|
data.attributes.trackerimageUrl | string |
The tracker image URL address. |
|
URL
|
data.attributes.url | string |
The URL address. |
|
Video Count
|
data.attributes.videoCount | integer |
The video count. |
|
Video URL Count
|
data.attributes.videoUrlCount | integer |
The video URL count. |
|
Created Date
|
data.attributes.createdDate | string |
The date created. |
|
Updated Date
|
data.attributes.updatedDate | string |
When updated date. |
|
Age Group
|
data.attributes.ageGroup | string |
The age group. |
|
Breed Secondary
|
data.attributes.breedSecondary | string |
The secondary breed. |
|
Breed Secondary ID
|
data.attributes.breedSecondaryId | integer |
The secondary breed identifier. |
|
Is Kids Ok
|
data.attributes.isKidsOk | boolean |
Whether is okay with kids. |
|
Is Dogs Ok
|
data.attributes.isDogsOk | boolean |
Whether is okay with dogs. |
|
Adopted Date
|
data.attributes.adoptedDate | string |
The adoption date. |
|
Size Current
|
data.attributes.sizeCurrent | float |
The current size. |
|
Data
|
data.relationships.breeds.data | array of object | |
|
Type
|
data.relationships.breeds.data.type | string |
The type. |
|
ID
|
data.relationships.breeds.data.id | string |
The identifier. |
|
Data
|
data.relationships.colors.data | array of object | |
|
Type
|
data.relationships.colors.data.type | string |
The type. |
|
ID
|
data.relationships.colors.data.id | string |
The identifier. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Data
|
data.relationships.statuses.data | array of object | |
|
Type
|
data.relationships.statuses.data.type | string |
The type. |
|
ID
|
data.relationships.statuses.data.id | string |
The identifier. |
|
Data
|
data.relationships.locations.data | array of object | |
|
Type
|
data.relationships.locations.data.type | string |
The type. |
|
ID
|
data.relationships.locations.data.id | string |
The identifier. |
|
Data
|
data.relationships.orgs.data | array of object | |
|
Type
|
data.relationships.orgs.data.type | string |
The type. |
|
ID
|
data.relationships.orgs.data.id | string |
The identifier. |
|
Data
|
data.relationships.pictures.data | array of object | |
|
Type
|
data.relationships.pictures.data.type | string |
The type. |
|
ID
|
data.relationships.pictures.data.id | string |
The identifier. |
|
Data
|
data.relationships.patterns.data | array of object | |
|
Type
|
data.relationships.patterns.data.type | string |
The type. |
|
ID
|
data.relationships.patterns.data.id | string |
The identifier. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Name
|
included.attributes.name | string |
The name. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Description
|
included.attributes.description | string |
The description. |
|
City
|
included.attributes.city | string |
The city. |
|
State
|
included.attributes.state | string |
The state. |
|
City/State
|
included.attributes.citystate | string |
The city and state. |
|
Postal Code
|
included.attributes.postalcode | string |
The postal code. |
|
Country
|
included.attributes.country | string |
The country. |
|
Lat
|
included.attributes.lat | float |
The latitude. |
|
Lon
|
included.attributes.lon | float |
The longitude. |
|
Coordinates
|
included.attributes.coordinates | string |
The coordinates. |
|
Postal Code Plus 4
|
included.attributes.postalcodePlus4 | string |
The postal code plus 4 digits. |
|
Email
|
included.attributes.email | string |
The email address. |
|
URL
|
included.attributes.url | string |
The URL address. |
|
Facebook URL
|
included.attributes.facebookUrl | string |
The Facebook URL address. |
|
Type
|
included.attributes.type | string |
The type. |
|
File Size
|
included.attributes.original.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.original.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.original.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.original.url | string |
The URL address. |
|
File Size
|
included.attributes.large.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.large.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.large.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.large.url | string |
The URL address. |
|
File Size
|
included.attributes.small.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.small.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.small.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.small.url | string |
The URL address. |
|
Order
|
included.attributes.order | integer |
The order. |
|
Created
|
included.attributes.created | string |
When created. |
|
Updated
|
included.attributes.updated | string |
When updated. |
|
Self
|
included.links.self | string |
The self. |
Get animals at organization by status
Retrieves a list of animals at an organization by status.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Identifier
|
id | True | string |
The identifier. |
|
Status
|
status | True | string |
The status. |
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Activity Level
|
data.attributes.activityLevel | string |
The activity level. |
|
Is Adoption Pending
|
data.attributes.isAdoptionPending | boolean |
Whether adoption is pending. |
|
Age Group
|
data.attributes.ageGroup | string |
The age group. |
|
Age
|
data.attributes.ageString | string |
The age. |
|
Birth Date
|
data.attributes.birthDate | string |
The birth date. |
|
Is Birth Date Exact
|
data.attributes.isBirthDateExact | boolean |
Whether birth date is exact. |
|
Breed
|
data.attributes.breedString | string |
The breed. |
|
Breed Primary
|
data.attributes.breedPrimary | string |
The primary breed. |
|
Breed Primary ID
|
data.attributes.breedPrimaryId | integer |
The primary breed identifier. |
|
Is Breed Mixed
|
data.attributes.isBreedMixed | boolean |
Whether is a mixed breed. |
|
Coat Length
|
data.attributes.coatLength | string |
The coat length. |
|
Color Details
|
data.attributes.colorDetails | string |
The color details. |
|
Is Courtesy Listing
|
data.attributes.isCourtesyListing | boolean |
Whether listing is courtesy. |
|
Is Current Vaccinations
|
data.attributes.isCurrentVaccinations | boolean |
Whether is current with vaccinations. |
|
Description Html
|
data.attributes.descriptionHtml | string |
The description in HTML. |
|
Description Text
|
data.attributes.descriptionText | string |
The description text. |
|
Is Needing Foster
|
data.attributes.isNeedingFoster | boolean |
Whether is needing foster. |
|
Is Found
|
data.attributes.isFound | boolean |
Whether was found. |
|
Priority
|
data.attributes.priority | integer |
The priority. |
|
Indoor Outdoor
|
data.attributes.indoorOutdoor | string |
The indoor and outdoor preference. |
|
Name
|
data.attributes.name | string |
The name. |
|
Picture Count
|
data.attributes.pictureCount | integer |
The picture count. |
|
Picture Thumbnail URL
|
data.attributes.pictureThumbnailUrl | string |
The thumbnail picture URL address. |
|
Search String
|
data.attributes.searchString | string |
The search string. |
|
Sex
|
data.attributes.sex | string |
The sex. |
|
Size Group
|
data.attributes.sizeGroup | string |
The group size. |
|
Size UOM
|
data.attributes.sizeUOM | string |
The size unit of measurement. |
|
Slug
|
data.attributes.slug | string |
The slug. |
|
Is Special Needs
|
data.attributes.isSpecialNeeds | boolean |
Whether is special needs. |
|
Is Sponsorable
|
data.attributes.isSponsorable | boolean |
Whether is sponsorable. |
|
Tracker Image URL
|
data.attributes.trackerimageUrl | string |
The tracker image URL address. |
|
URL
|
data.attributes.url | string |
The URL address. |
|
Video Count
|
data.attributes.videoCount | integer |
The video count. |
|
Video URL Count
|
data.attributes.videoUrlCount | integer |
The video URL count. |
|
Created Date
|
data.attributes.createdDate | string |
The date created. |
|
Updated Date
|
data.attributes.updatedDate | string |
When updated date. |
|
Data
|
data.relationships.breeds.data | array of object | |
|
Type
|
data.relationships.breeds.data.type | string |
The type. |
|
ID
|
data.relationships.breeds.data.id | string |
The identifier. |
|
Data
|
data.relationships.colors.data | array of object | |
|
Type
|
data.relationships.colors.data.type | string |
The type. |
|
ID
|
data.relationships.colors.data.id | string |
The identifier. |
|
Data
|
data.relationships.patterns.data | array of object | |
|
Type
|
data.relationships.patterns.data.type | string |
The type. |
|
ID
|
data.relationships.patterns.data.id | string |
The identifier. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Data
|
data.relationships.statuses.data | array of object | |
|
Type
|
data.relationships.statuses.data.type | string |
The type. |
|
ID
|
data.relationships.statuses.data.id | string |
The identifier. |
|
Data
|
data.relationships.locations.data | array of object | |
|
Type
|
data.relationships.locations.data.type | string |
The type. |
|
ID
|
data.relationships.locations.data.id | string |
The identifier. |
|
Data
|
data.relationships.orgs.data | array of object | |
|
Type
|
data.relationships.orgs.data.type | string |
The type. |
|
ID
|
data.relationships.orgs.data.id | string |
The identifier. |
|
Data
|
data.relationships.pictures.data | array of object | |
|
Type
|
data.relationships.pictures.data.type | string |
The type. |
|
ID
|
data.relationships.pictures.data.id | string |
The identifier. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Name
|
included.attributes.name | string |
The name. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Description
|
included.attributes.description | string |
The description. |
|
City
|
included.attributes.city | string |
The city. |
|
State
|
included.attributes.state | string |
The state. |
|
City/State
|
included.attributes.citystate | string |
The city and state. |
|
Postal Code
|
included.attributes.postalcode | string |
The postal code. |
|
Country
|
included.attributes.country | string |
The country. |
|
Lat
|
included.attributes.lat | float |
The latitude. |
|
Lon
|
included.attributes.lon | float |
The longitude. |
|
Coordinates
|
included.attributes.coordinates | string |
The coordinates. |
|
Postal Code Plus 4
|
included.attributes.postalcodePlus4 | string |
The postal code plus 4 digits. |
|
Email
|
included.attributes.email | string |
The email address. |
|
URL
|
included.attributes.url | string |
The URL address. |
|
Facebook URL
|
included.attributes.facebookUrl | string |
The Facebook URL address. |
|
Type
|
included.attributes.type | string |
The type. |
|
File Size
|
included.attributes.original.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.original.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.original.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.original.url | string |
The URL address. |
|
File Size
|
included.attributes.large.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.large.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.large.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.large.url | string |
The URL address. |
|
File Size
|
included.attributes.small.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.small.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.small.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.small.url | string |
The URL address. |
|
Order
|
included.attributes.order | integer |
The order. |
|
Created
|
included.attributes.created | string |
When created. |
|
Updated
|
included.attributes.updated | string |
When updated. |
|
Self
|
included.links.self | string |
The self. |
Get animals by status
Retrieves a list of animals by status.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Status
|
status | True | string |
The status. |
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Is Adoption Pending
|
data.attributes.isAdoptionPending | boolean |
Whether adoption is pending. |
|
Age Group
|
data.attributes.ageGroup | string |
The age group. |
|
Age
|
data.attributes.ageString | string |
The age. |
|
Birth Date
|
data.attributes.birthDate | string |
The birth date. |
|
Is Birth Date Exact
|
data.attributes.isBirthDateExact | boolean |
Whether birth date is exact. |
|
Breed
|
data.attributes.breedString | string |
The breed. |
|
Breed Primary
|
data.attributes.breedPrimary | string |
The primary breed. |
|
Breed Primary ID
|
data.attributes.breedPrimaryId | integer |
The primary breed identifier. |
|
Breed Secondary
|
data.attributes.breedSecondary | string |
The secondary breed. |
|
Breed Secondary ID
|
data.attributes.breedSecondaryId | integer |
The secondary breed identifier. |
|
Coat Length
|
data.attributes.coatLength | string |
The coat length. |
|
Is Courtesy Listing
|
data.attributes.isCourtesyListing | boolean |
Whether listing is courtesy. |
|
Description Html
|
data.attributes.descriptionHtml | string |
The description in HTML. |
|
Description Text
|
data.attributes.descriptionText | string |
The description text. |
|
Is Needing Foster
|
data.attributes.isNeedingFoster | boolean |
Whether is needing foster. |
|
Is Found
|
data.attributes.isFound | boolean |
Whether was found. |
|
Priority
|
data.attributes.priority | integer |
The priority. |
|
Name
|
data.attributes.name | string |
The name. |
|
Picture Count
|
data.attributes.pictureCount | integer |
The picture count. |
|
Picture Thumbnail URL
|
data.attributes.pictureThumbnailUrl | string |
The thumbnail picture URL address. |
|
Rescue ID
|
data.attributes.rescueId | string |
The rescue identifier. |
|
Search String
|
data.attributes.searchString | string |
The search string. |
|
Sex
|
data.attributes.sex | string |
The sex. |
|
Size Current
|
data.attributes.sizeCurrent | float |
The current size. |
|
Size UOM
|
data.attributes.sizeUOM | string |
The size unit of measurement. |
|
Slug
|
data.attributes.slug | string |
The slug. |
|
Is Sponsorable
|
data.attributes.isSponsorable | boolean |
Whether is sponsorable. |
|
Tracker Image URL
|
data.attributes.trackerimageUrl | string |
The tracker image URL address. |
|
Video Count
|
data.attributes.videoCount | integer |
The video count. |
|
Video URL Count
|
data.attributes.videoUrlCount | integer |
The video URL count. |
|
Created Date
|
data.attributes.createdDate | string |
The date created. |
|
Updated Date
|
data.attributes.updatedDate | string |
When updated date. |
|
Is Breed Mixed
|
data.attributes.isBreedMixed | boolean |
Whether is a mixed breed. |
|
Is Cats Ok
|
data.attributes.isCatsOk | boolean |
Whether is okay with cats. |
|
Is Current Vaccinations
|
data.attributes.isCurrentVaccinations | boolean |
Whether is current with vaccinations. |
|
Is Declawed
|
data.attributes.isDeclawed | boolean |
Whether is declawed. |
|
Is Dogs Ok
|
data.attributes.isDogsOk | boolean |
Whether is okay with dogs. |
|
Is House-trained
|
data.attributes.isHousetrained | boolean |
Whether is house-trained. |
|
Is Kids Ok
|
data.attributes.isKidsOk | boolean |
Whether is okay with kids. |
|
Size Group
|
data.attributes.sizeGroup | string |
The group size. |
|
Activity Level
|
data.attributes.activityLevel | string |
The activity level. |
|
Energy Level
|
data.attributes.energyLevel | string |
The energy level. |
|
Indoor Outdoor
|
data.attributes.indoorOutdoor | string |
The indoor and outdoor preference. |
|
New People Reaction
|
data.attributes.newPeopleReaction | string |
The reaction with new people. |
|
Adoption Fee
|
data.attributes.adoptionFeeString | string |
The adoption fee. |
|
Adult Sexes Ok
|
data.attributes.adultSexesOk | string |
The adult sexes okay with. |
|
Exercise Needs
|
data.attributes.exerciseNeeds | string |
The exercise needs. |
|
Fence Needs
|
data.attributes.fenceNeeds | string |
The fence needs. |
|
Grooming Needs
|
data.attributes.groomingNeeds | string |
The grooming needs. |
|
Obedience Training
|
data.attributes.obedienceTraining | string |
The obedience training. |
|
Owner Experience
|
data.attributes.ownerExperience | string |
The previous owner experience. |
|
Shedding Level
|
data.attributes.sheddingLevel | string |
The shedding level. |
|
Is Special Needs
|
data.attributes.isSpecialNeeds | boolean |
Whether is special needs. |
|
Vocal Level
|
data.attributes.vocalLevel | string |
The vocal level. |
|
Is Yard Required
|
data.attributes.isYardRequired | boolean |
Whether yard is required. |
|
Color Details
|
data.attributes.colorDetails | string |
The color details. |
|
Eye Color
|
data.attributes.eyeColor | string |
The eye color. |
|
Kill Reason
|
data.attributes.killReason | string |
The kill reason. |
|
Qualities
|
data.attributes.qualities | array of string | |
|
URL
|
data.attributes.url | string |
The URL address. |
|
Sponsorship Minimum
|
data.attributes.sponsorshipMinimum | string |
The sponsorship minimum. |
|
Sponsors
|
data.attributes.sponsors | string |
The sponsors. |
|
Summary
|
data.attributes.summary | string |
The summary. |
|
Found Date
|
data.attributes.foundDate | string |
The date found. |
|
Available Date
|
data.attributes.availableDate | string |
The date available. |
|
Adopted Date
|
data.attributes.adoptedDate | string |
The adoption date. |
|
Size Potential
|
data.attributes.sizePotential | integer |
The potential size. |
|
Data
|
data.relationships.breeds.data | array of object | |
|
Type
|
data.relationships.breeds.data.type | string |
The type. |
|
ID
|
data.relationships.breeds.data.id | string |
The identifier. |
|
Data
|
data.relationships.colors.data | array of object | |
|
Type
|
data.relationships.colors.data.type | string |
The type. |
|
ID
|
data.relationships.colors.data.id | string |
The identifier. |
|
Data
|
data.relationships.patterns.data | array of object | |
|
Type
|
data.relationships.patterns.data.type | string |
The type. |
|
ID
|
data.relationships.patterns.data.id | string |
The identifier. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Data
|
data.relationships.statuses.data | array of object | |
|
Type
|
data.relationships.statuses.data.type | string |
The type. |
|
ID
|
data.relationships.statuses.data.id | string |
The identifier. |
|
Data
|
data.relationships.locations.data | array of object | |
|
Type
|
data.relationships.locations.data.type | string |
The type. |
|
ID
|
data.relationships.locations.data.id | string |
The identifier. |
|
Data
|
data.relationships.orgs.data | array of object | |
|
Type
|
data.relationships.orgs.data.type | string |
The type. |
|
ID
|
data.relationships.orgs.data.id | string |
The identifier. |
|
Data
|
data.relationships.pictures.data | array of object | |
|
Type
|
data.relationships.pictures.data.type | string |
The type. |
|
ID
|
data.relationships.pictures.data.id | string |
The identifier. |
|
Data
|
data.relationships.fosters.data | array of object | |
|
Type
|
data.relationships.fosters.data.type | string |
The type. |
|
ID
|
data.relationships.fosters.data.id | string |
The identifier. |
|
Data
|
data.relationships.videos.data | array of object | |
|
Type
|
data.relationships.videos.data.type | string |
The type. |
|
ID
|
data.relationships.videos.data.id | string |
The identifier. |
|
Data
|
data.relationships.videourls.data | array of object | |
|
Type
|
data.relationships.videourls.data.type | string |
The type. |
|
ID
|
data.relationships.videourls.data.id | string |
The identifier. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Name
|
included.attributes.name | string |
The name. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Description
|
included.attributes.description | string |
The description. |
|
Street
|
included.attributes.street | string |
The street. |
|
City
|
included.attributes.city | string |
The city. |
|
State
|
included.attributes.state | string |
The state. |
|
City/State
|
included.attributes.citystate | string |
The city and state. |
|
Postal Code
|
included.attributes.postalcode | string |
The postal code. |
|
Country
|
included.attributes.country | string |
The country. |
|
Phone
|
included.attributes.phone | string |
The phone. |
|
Lat
|
included.attributes.lat | float |
The latitude. |
|
Lon
|
included.attributes.lon | float |
The longitude. |
|
Coordinates
|
included.attributes.coordinates | string |
The coordinates. |
|
Email
|
included.attributes.email | string |
The email address. |
|
URL
|
included.attributes.url | string |
The URL address. |
|
Facebook URL
|
included.attributes.facebookUrl | string |
The Facebook URL address. |
|
Adoption Process
|
included.attributes.adoptionProcess | string |
The adoption process. |
|
About
|
included.attributes.about | string |
The about. |
|
Services
|
included.attributes.services | string |
The services. |
|
Type
|
included.attributes.type | string |
The type. |
|
File Size
|
included.attributes.original.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.original.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.original.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.original.url | string |
The URL address. |
|
File Size
|
included.attributes.large.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.large.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.large.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.large.url | string |
The URL address. |
|
File Size
|
included.attributes.small.filesize | integer |
The file size. |
|
Resolution X
|
included.attributes.small.resolutionX | integer |
The x resolution. |
|
Resolution Y
|
included.attributes.small.resolutionY | integer |
The y resolution. |
|
URL
|
included.attributes.small.url | string |
The URL address. |
|
Order
|
included.attributes.order | integer |
The order. |
|
Created
|
included.attributes.created | string |
When created. |
|
Updated
|
included.attributes.updated | string |
When updated. |
|
First Name
|
included.attributes.firstname | string |
The first name. |
|
Full Name
|
included.attributes.fullname | string |
The full name. |
|
Adoption URL
|
included.attributes.adoptionUrl | string |
The adoption URL address. |
|
Donation URL
|
included.attributes.donationUrl | string |
The donation URL address. |
|
Sponsorship URL
|
included.attributes.sponsorshipUrl | string |
The sponsorship URL address. |
|
File Size
|
included.attributes.fileSize | integer |
The file size. |
|
Video ID
|
included.attributes.videoId | string |
The video identifier. |
|
URL Thumbnail
|
included.attributes.urlThumbnail | string |
The thumbnail URL address. |
|
Self
|
included.links.self | string |
The self. |
Get breed by ID
Retrieves the breed information by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Identifier
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Name
|
data.attributes.name | string |
The name. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Self
|
data.relationships.species.data.links.self | string |
The self. |
|
Self
|
data.relationships.species.links.self | string |
The self. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Self
|
links.self | string |
The self. |
|
First
|
links.first | string |
The first. |
|
Last
|
links.last | string |
The last. |
Get breeds
Retrieves a list of breeds.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Name
|
data.attributes.name | string |
The name. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Self
|
data.relationships.species.data.links.self | string |
The self. |
|
Self
|
data.relationships.species.links.self | string |
The self. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Self
|
links.self | string |
The self. |
|
First
|
links.first | string |
The first. |
|
Last
|
links.last | string |
The last. |
|
Next
|
links.next | string |
The next. |
Get breeds by species
Retrieves a list of breeds by species.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Species
|
species | True | string |
The species. |
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Name
|
data.attributes.name | string |
The name. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Self
|
data.relationships.species.data.links.self | string |
The self. |
|
Self
|
data.relationships.species.links.self | string |
The self. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Self
|
links.self | string |
The self. |
|
First
|
links.first | string |
The first. |
|
Last
|
links.last | string |
The last. |
|
Next
|
links.next | string |
The next. |
Get breeds by species ID
Retrieves a list of breeds by species identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Identifier
|
id | True | string |
The identifier. |
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Name
|
data.attributes.name | string |
The name. |
|
Data
|
data.relationships.species.data | array of object | |
|
Type
|
data.relationships.species.data.type | string |
The type. |
|
ID
|
data.relationships.species.data.id | string |
The identifier. |
|
Self
|
data.relationships.species.data.links.self | string |
The self. |
|
Self
|
data.relationships.species.links.self | string |
The self. |
|
Included
|
included | array of object | |
|
Type
|
included.type | string |
The type. |
|
ID
|
included.id | string |
The identifier. |
|
Singular
|
included.attributes.singular | string |
The singular. |
|
Plural
|
included.attributes.plural | string |
The plural. |
|
Young Singular
|
included.attributes.youngSingular | string |
The young singular. |
|
Young Plural
|
included.attributes.youngPlural | string |
The young plural. |
|
Self
|
links.self | string |
The self. |
|
First
|
links.first | string |
The first. |
|
Last
|
links.last | string |
The last. |
Get organization by ID
Retrieve an organization by identifier.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Identifier
|
id | True | string |
The identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Name
|
data.attributes.name | string |
The name. |
|
City
|
data.attributes.city | string |
The city. |
|
State
|
data.attributes.state | string |
The state. |
|
Postal Code
|
data.attributes.postalcode | string |
The postal code. |
|
Postal Code Plus 4
|
data.attributes.postalcodePlus4 | string |
The postal code plus 4 digits. |
|
Country
|
data.attributes.country | string |
The country. |
|
Email
|
data.attributes.email | string |
The email address. |
|
URL
|
data.attributes.url | string |
The URL address. |
|
Facebook URL
|
data.attributes.facebookUrl | string |
The Facebook URL address. |
|
Type
|
data.attributes.type | string |
The type. |
|
Is Common Application Accepted
|
data.attributes.isCommonapplicationAccepted | boolean |
Whether common application is accepted. |
|
Lat
|
data.attributes.lat | float |
The latitude. |
|
Lon
|
data.attributes.lon | float |
The longitude. |
|
Coordinates
|
data.attributes.coordinates | string |
The coordinates. |
|
City/State
|
data.attributes.citystate | string |
The city and state. |
Get organizations
Retrieves a list of organizations
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
Page
|
page | integer |
The page number. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Count
|
meta.count | integer |
The count. |
|
Count Returned
|
meta.countReturned | integer |
The count returned. |
|
Page Returned
|
meta.pageReturned | integer |
The page returned. |
|
Limit
|
meta.limit | integer |
The limit. |
|
Pages
|
meta.pages | integer |
The number of pages. |
|
Transaction ID
|
meta.transactionId | string |
The transaction identifier. |
|
Data
|
data | array of object | |
|
Type
|
data.type | string |
The type. |
|
ID
|
data.id | string |
The identifier. |
|
Name
|
data.attributes.name | string |
The name. |
|
City
|
data.attributes.city | string |
The city. |
|
State
|
data.attributes.state | string |
The state. |
|
Postal Code
|
data.attributes.postalcode | string |
The postal code. |
|
Postal Code Plus 4
|
data.attributes.postalcodePlus4 | string |
The postal code plus 4 digits. |
|
Country
|
data.attributes.country | string |
The country. |
|
Email
|
data.attributes.email | string |
The email address. |
|
URL
|
data.attributes.url | string |
The URL address. |
|
Facebook URL
|
data.attributes.facebookUrl | string |
The Facebook URL address. |
|
Type
|
data.attributes.type | string |
The type. |
|
Is Common Application Accepted
|
data.attributes.isCommonapplicationAccepted | boolean |
Whether common application is accepted. |
|
Lat
|
data.attributes.lat | float |
The latitude. |
|
Lon
|
data.attributes.lon | float |
The longitude. |
|
Coordinates
|
data.attributes.coordinates | string |
The coordinates. |
|
City/State
|
data.attributes.citystate | string |
The city and state. |
|
Street
|
data.attributes.street | string |
The street. |
|
Phone
|
data.attributes.phone | string |
The phone. |
|
Serve Areas
|
data.attributes.serveAreas | string |
The areas served. |
|
Services
|
data.attributes.services | string |
The services. |
|
About
|
data.attributes.about | string |
The about. |
|
Adoption Process
|
data.attributes.adoptionProcess | string |
The adoption process. |
|
Adoption URL
|
data.attributes.adoptionUrl | string |
The adoption URL address. |
|
Donation URL
|
data.attributes.donationUrl | string |
The donation URL address. |
|
Sponsorship URL
|
data.attributes.sponsorshipUrl | string |
The sponsorship URL address. |