← Tools Reference

The Dog API

The Dog API integration (Design & Media, Data). Imported from open-connector.

API key9 toolshttps://api.thedogapi.com/v1
GET
the_dog_api_search_images
Search for dog images with optional breed, category, type, size, and paging filters.

/images/search

11 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe number of images to return.
pageintegeroptionalThe zero-based result page number.
orderstringoptionalThe Dog API result order.
sizestringoptionalThe image size preset requested from The Dog API.
mimeTypesstringoptionalComma-separated MIME type filters accepted by The Dog API, such as jpg,png or g…
hasBreedsbooleanoptionalWhether to only return images that have breed information attached.
breedIdsstringoptionalComma-separated breed identifiers used to filter image results.
categoryIdsstringoptionalComma-separated category identifiers used to filter image results.
includeBreedsbooleanoptionalWhether The Dog API should include breed objects in image results.
includeCategoriesbooleanoptionalWhether The Dog API should include category objects in image results.
formatstringoptionalThe response format requested from The Dog API.
GET
the_dog_api_get_image
Get one dog image by its The Dog API image identifier.

/images/{imageId}

1 parameter
ParamTypeRequiredDescription
imageIdstringrequiredThe Dog API image identifier.
GET
the_dog_api_list_breeds
List dog breeds supported by The Dog API.

/breeds

2 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe number of breeds to return.
pageintegeroptionalThe zero-based result page number.
GET
the_dog_api_search_breeds
Search dog breeds by breed name.

/breeds/search

1 parameter
ParamTypeRequiredDescription
querystringoptionalThe breed name search query.
GET
the_dog_api_get_breed
Get one dog breed by its The Dog API breed identifier.

/breeds/{breedId}

1 parameter
ParamTypeRequiredDescription
breedIdstringrequiredThe Dog API breed identifier.
GET
the_dog_api_list_favourites
List favourite dog images for the connected The Dog API account.

/favourites

3 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe number of records to return.
pageintegeroptionalThe zero-based result page number.
subIdstringoptionalA custom user identifier stored by The Dog API.
DELETE
the_dog_api_delete_favourite
Delete one favourite dog image record.

/favourites/{favouriteId}

1 parameter
ParamTypeRequiredDescription
favouriteIdstringrequiredThe Dog API favourite identifier.
GET
the_dog_api_list_votes
List dog image votes for the connected The Dog API account.

/votes

3 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe number of records to return.
pageintegeroptionalThe zero-based result page number.
subIdstringoptionalA custom user identifier stored by The Dog API.
DELETE
the_dog_api_delete_vote
Delete one dog image vote.

/votes/{voteId}

1 parameter
ParamTypeRequiredDescription
voteIdstringrequiredThe Dog API vote identifier.