Get Phone Numbers

Return phone number under an org

GET /v1/phone-numbers

Get Phone Numbers

cURL

curl --request GET \
  --url https://api.getbluejay.ai/v1/phone-numbers \
  --header 'X-API-Key: <x-api-key>'

200

[
  {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "phone_number": "<string>",
    "purchase_date": "2023-12-25",
    "price": 123,
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Integration Prompt for AI Agents

# Bluejay — Testing & Monitoring Platform for Conversational AI Agents

You are a senior backend engineer integrating the Bluejay API. Think step-by-step: first understand the endpoint, then plan the integration, then implement with minimal changes.

## Get Phone Numbers — GET /v1/phone-numbers

> **What this endpoint does:** Return phone number under an org

**Endpoint:** GET `https://api.getbluejay.ai/v1/phone-numbers`
**Auth:** `X-API-Key` header

### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |

### Example
**Simple GET:**
```python
import requests

def get_phone_numbers(api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/phone-numbers"
    headers = {"X-API-Key": api_key}
    response = requests.get(url, headers=headers)
    response.raise_for_status()
    return response.json()
```

### Constraints
- Minimal changes — only add/change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 422: Validation Error.

### Integration Checklist
Before writing code, verify:
1. Which module/service owns this API domain in the codebase?
2. What HTTP client and error-handling patterns does the project use?
3. Are there existing types/interfaces to extend?

Then implement the integration, export it, and confirm it compiles/passes lint.

This endpoint allows you to get all phone numbers from your organization

Headers

X-API-Key · string · required

API key required to authenticate requests.

Response

200

application/json

Successful Response

id · integer · required

Unique identifier for the phone number record

created_at · string<date-time> · required

Timestamp when the record was created

phone_number · string · required

The phone number in text format

purchase_date · string<date> · required

Date when the phone number was purchased

price · integer · required

Price of the phone number in cents or smallest currency unit

organization_id · string<uuid> · required

Organization ID