Get paginated finalized sentences for a voice note

curl --request GET \
  --url https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "transcript": "<string>",
      "start": 123,
      "end": 123,
      "speaker": 123,
      "speakerId": "<string>"
    }
  ],
  "patient": {
    "id": "<string>",
    "name": "<string>",
    "firstname": "<string>",
    "middlename": "<string>",
    "lastname": "<string>",
    "email": "<string>",
    "suffix": "<string>",
    "image": "<string>",
    "dob": "<string>",
    "deceased": true,
    "sex": "<string>",
    "fmrn": "<string>",
    "omrn": "<string>",
    "ssn": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "stateZIP": "<string>",
    "county": "<string>",
    "aptNumber": "<string>",
    "homePhone": "<string>",
    "workPhone": "<string>",
    "cellPhone": "<string>",
    "fax": "<string>",
    "language": "<string>",
    "locationType": "<string>",
    "residenceType": "<string>",
    "residenceName": "<string>",
    "timezone": "<string>",
    "physician": "<string>",
    "admissionSource": "<string>",
    "insuranceProvider": "<string>",
    "medicareNumber": "<string>",
    "medicaidNumber": "<string>",
    "organizationId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "nextCursor": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

GET

notes

{voiceNoteId}

sentences

Get paginated finalized sentences for a voice note

curl --request GET \
  --url https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.enzo.health/api/v1/notes/{voiceNoteId}/sentences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "transcript": "<string>",
      "start": 123,
      "end": 123,
      "speaker": 123,
      "speakerId": "<string>"
    }
  ],
  "patient": {
    "id": "<string>",
    "name": "<string>",
    "firstname": "<string>",
    "middlename": "<string>",
    "lastname": "<string>",
    "email": "<string>",
    "suffix": "<string>",
    "image": "<string>",
    "dob": "<string>",
    "deceased": true,
    "sex": "<string>",
    "fmrn": "<string>",
    "omrn": "<string>",
    "ssn": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "stateZIP": "<string>",
    "county": "<string>",
    "aptNumber": "<string>",
    "homePhone": "<string>",
    "workPhone": "<string>",
    "cellPhone": "<string>",
    "fax": "<string>",
    "language": "<string>",
    "locationType": "<string>",
    "residenceType": "<string>",
    "residenceName": "<string>",
    "timezone": "<string>",
    "physician": "<string>",
    "admissionSource": "<string>",
    "insuranceProvider": "<string>",
    "medicareNumber": "<string>",
    "medicaidNumber": "<string>",
    "organizationId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "nextCursor": "<string>"
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

voiceNoteId

string

required

Query Parameters

cursor

string | null

limit

number

default:5

Required range: 1 <= x <= 100

isPaginated

string

default:true

Response

Successful response

items

object[]

required

Show child attributes

patient

object | null

required

Show child attributes

nextCursor

string | null

required

Getting Started

Workflow Run

Workflow

Results

Webhook

Processors

Credentials

Organizations

Patients

Voice Notes

Transcripts

Survey

Folders

Visits

OASIS

Subscribers

User

esign

Get paginated finalized sentences for a voice note

Authorizations

Path Parameters

Query Parameters

Response