Skip to main content
GET
/
users
/
{user_id}
/
custom_records
/
{record_id}
Get custom record
curl --request GET \
  --url https://production.api.onvy.health/users/{user_id}/custom_records/{record_id} \
  --header 'X-API-Key: <api-key>'
{
  "custom_records_type_id": "<string>",
  "data": {},
  "id": "<string>",
  "project_id": "<string>",
  "user_id": "<string>",
  "description": "<string>",
  "attachments": [
    {
      "mime_type": "<string>",
      "description": "<string>",
      "data_base64": "<string>",
      "data_url": "<string>"
    }
  ],
  "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

user_id
string
required

User ID (e.g., google_104940819145861640201)

record_id
string
required

Custom record ID

Response

Custom record details

custom_records_type_id
string
required

ID of the custom record type this record conforms to

data
object
required

Payload data matching the custom record type's JSON Schema

id
string

Custom record ID (ULID)

project_id
string
user_id
string
description
string | null
attachments
object[] | null

Optional file attachments associated with this record

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