Skip to main content
GET
/
custom_records_types
/
{type_id}
Get custom record type
curl --request GET \
  --url https://production.api.onvy.health/custom_records_types/{type_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "project_id": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "data_jsonschema": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Path Parameters

​
type_id
string
required

Custom record type ID

Response

Custom record type details

​
id
string

Developer-defined custom record type identifier (e.g., blood_test_v1)

​
project_id
string

Project ID

​
display_name
string

Human-readable name of the custom record type

​
description
string | null

Optional description of the custom record type

​
data_jsonschema
object

JSON Schema describing the structure of the data field for records of this type

​
created_at
string<date-time>
​
updated_at
string<date-time>