Skip to content

List pet profiles ​

GET/pet-profiles

List the current user's pet profiles with page-based pagination. Every item in the list is a complete pet-profile object (its fields match the data returned by Create a pet profile) and does not include extension records.

Request URL ​

text
GET https://open-api.habitaxx.com/v1/ms-ai-fast/pet-profiles?page=1&limit=20

Request headers ​

http
Authorization: Bearer <ACCESS_TOKEN>

Query parameters ​

ParameterTypeRequiredDefaultDescription
pageintegerNo1Page number, starting at 1.
limitintegerNo10Number of items per page, maximum 200.
pet_typeintegerNo—Filter by pet type: 1 cat, 2 dog, 3 exotic pet.
namestringNo—Filter by pet name; a Chinese name must be URL-encoded.
localestringNo—Display language, affecting breed_display_name.

Response example ​

json
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": 44,
      "user_uuid": "<USER_UUID>",
      "name": "团子",
      "avatar": null,
      "birthday": "2023-06-01T00:00:00",
      "gender": 1,
      "pet_type": 2,
      "pet_variety": "柴犬",
      "breed_code": "dog.shiba-inu",
      "locale": "zh-CN",
      "breed_display_name": "柴犬",
      "weight": "10.10kg",
      "is_neutered": 1,
      "is_del": 0,
      "created_at": "2026-08-27T11:20:31",
      "updated_at": "2026-08-27T11:20:31"
    }
  ]
}

Response fields ​

The response data is an array of pet-profile objects; see Create a pet profile for the object fields.

Pagination conventions ​

  • Use page + limit, not cursor pagination; the request parameter is limit, not page_size.
  • When many profiles are needed in one call, limit can be raised to 200; larger values are rejected.
  • The response returns only the profile array — there is no total or page_info: count results on your side, or use "does the page length equal limit" to detect another page.
  • Do not change the filter conditions while paging, otherwise the result set changes.

Next steps ​

最近更新

Qijie Open Platform · API Documentation