# Phone Numbers

## List phone numbers

`client.phoneNumbers.list(RequestOptionsoptions?): PhoneNumberListResponse`

**get** `/v3/phone_numbers`

Returns all phone numbers assigned to the authenticated partner.
Use this endpoint to discover which phone numbers are available for
use as the `from` field when creating a chat, listing chats, or sending a voice memo.

### Returns

- `PhoneNumberListResponse`

  - `phone_numbers: Array<PhoneNumber>`

    List of phone numbers assigned to the partner

    - `id: string`

      Unique identifier for the phone number

    - `phone_number: string`

      Phone number in E.164 format

### Example

```typescript
import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const phoneNumbers = await client.phoneNumbers.list();

console.log(phoneNumbers.phone_numbers);
```

#### Response

```json
{
  "phone_numbers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "phone_number": "+12025551234"
    }
  ]
}
```

## Domain Types

### Phone Number List Response

- `PhoneNumberListResponse`

  - `phone_numbers: Array<PhoneNumber>`

    List of phone numbers assigned to the partner

    - `id: string`

      Unique identifier for the phone number

    - `phone_number: string`

      Phone number in E.164 format