---
name: "getPetBreedList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "getPetBreedList - Get pet breed."
---

## getPetBreedList

> [VERSION] @ray-js/ray >= 1.6.27

### Description

Get pet breed list

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | `GetPetBreedList` | Yes | Request parameters: petType is cat or dog |

### Return Value

Type: `Promise<Object[]>`

Promise that resolves to the breed list (code, multilingual name, initial, etc.)
| Property | Type | Description |
| --- | --- | --- |
| `breedCode` | `string` | Breed code |
| `name` | `string` | Breed multilingual name |
| `headerChar` | `string` | First letter of the pet name; available only for Chinese and English |

### Referenced Types

##### `type` GetPetBreedList

| Property | Type | Description |
| --- | --- | --- |
| `petType` | `"cat" \| "dog"` | Pet species type: cat, dog |


### Examples

#### Request example

```typescript
import { getPetBreedList } from '@ray-js/ray';

getPetBreedList({
  petType: 'dog',
});
```

#### Response example

```json
[
  {
    "breedCode": "xxx",
    "name": "Dogo Argentino",
    "headerChar": "A"
  }
]
```