Custom Fields / Available Types
/v3/custom-data/available-types endpoint reference.
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.
Responses
200 OK
Available business object types retrieved successfully.
DTO: AvailableTypeDTO
[
{
"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
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