Get Communities

Get all communities, optionally filtered by digital human (test case).

GET /v1/communities

Get Communities

cURL

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

200

{
  "communities": [
    {
      "id": "<string>",
      "title": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "digital_human_ids": [
        123
      ]
    }
  ],
  "total_count": 123
}

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 Communities — GET /v1/communities

> **What this endpoint does:** Get all communities, optionally filtered by digital human (test case).

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

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

Review the full parameter list at https://docs.getbluejay.ai/api-reference/endpoint/get-communities and include any optional parameters (e.g., `digital_human_id`) that serve your integration's use case and align with Bluejay's testing and monitoring capabilities.

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

def get_communities(api_key: str) -> dict:
    url = "https://api.getbluejay.ai/v1/communities"
    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 retrieve communities.

Headers

X-API-Key · string · required

API key required to authenticate requests.

Query Parameters

digital_human_id · integer | null

Response

200

application/json

Successful Response

Response model for listing communities

communities · CommunityResponse · object[] · required

List of communities

Show child attributes

total_count · integer · required

Total number of communities