---
schema: "agents-md/1.0"
ai_agents_docs_site_root: "https://agents.1health.io/public/demo/api/"
rest_api_root: "/v3/custom-data/available-types"
path_to_agent_file: "https://agents.1health.io/public/demo/api/v3/custom-data/available-types/agents.md"
kind: "endpoints"
methods: [GET]
api_version: "v3"
parent: "https://agents.1health.io/public/demo/api/v3/custom-data/agents.md"
html: "https://agents.1health.io/public/demo/api/v3/custom-data/available-types/index.html"
how_to: "https://agents.1health.io/public/demo/api/v3/custom-data/available-types/how-to.md"
use_case: "https://agents.1health.io/public/demo/api/v3/custom-data/available-types/use-case.md"
source_version: "43d07c0335624b7661c2872315a5f184e8c3d832"
extractor_model: "gpt-4o-2024-08-06"
extractor_prompt_version: "2026-08-13.v1"
reconciler_model: "claude-sonnet-4-6"
reconciler_prompt_version: "2026-08-13.v1"
generated_at: "2026-08-27T01:13:03.949984+00:00"
---

# /v3/custom-data/available-types

**URL**: https://demo.1health.io/api/v3/custom-data/available-types

_No description available in the API specification._

## Endpoints

| Endpoint | Method | Description |
| --- | --- | --- |
| /v3/custom-data/available-types | GET | List the business object types available for custom data |

---

## GET /v3/custom-data/available-types

List the business object types available for custom data

### Overview

Returns the whitelisted business object types a developer may define custom data on, each with its `name` and `key`. The whitelist is curated centrally and is identical across dev, demo, qa and prod. Only the whitelisted subset is exposed — the full type catalogue is never returned. Returns an empty list when the whitelist has not been configured. Requires authentication.

### Authorization

Bearer JWT required. See the [authentication guide](https://agents.1health.io/public/demo/api/authentication/agents.md).

### Responses

#### 200 OK

Available business object types retrieved successfully.

**DTO**: `AvailableTypeDTO`

```json
[
  {
    "id": 1001,
    "name": "example-value",
    "key": "example-value"
  }
]
```

| Field | Type | Nullable | Description |
| --- | --- | --- | --- |
| id | Long | No | The business object type id, used as boClassId when creating a custom data definition. |
| name | String | No | The human-readable name of the business object type. |
| key | String | No | The stable key of the business object type. |

#### 401 Unauthorized

Not authenticated — valid session required.

### Example

```bash
curl -X GET "https://demo.1health.io/api/v3/custom-data/available-types" \
  -H "Authorization: Bearer $TOKEN"
```

---

## Navigation
Parent: https://agents.1health.io/public/demo/api/v3/custom-data/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md