cURL
curl "https://api.haau3.com/v1/fhir/r4/Endpoint?organization=Organization-1326655846&_count=2" \
-H "Authorization: Bearer $HAAU3_API_KEY"import { Haau3 } from "@haau3/sdk";
const haau3 = new Haau3(); // reads HAAU3_API_KEY
const bundle = await haau3.searchEndpoint({ organization: "Organization-1326655846", _count: 2 });
console.log(bundle.entry?.length ?? 0);
from haau3 import Haau3
client = Haau3() # reads HAAU3_API_KEY
bundle = client.search_endpoint(organization="Organization-1326655846", count=2)
print(len(bundle.get("entry", [])))
package main
import (
"context"
"fmt"
"log"
"github.com/haau3/haau3-go"
)
func main() {
ctx := context.Background()
client, err := haau3.NewClient() // reads HAAU3_API_KEY
if err != nil {
log.Fatal(err)
}
bundle, err := client.SearchEndpoint(ctx, haau3.SearchEndpointParams{Organization: new("Organization-1326655846"), Count: new(2)})
if err != nil {
log.Fatal(err)
}
fmt.Println(len(bundle.Entry))
}
{
"resourceType": "Bundle",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://api.haau3.com/v1/fhir/r4/Endpoint?organization=Organization-1326655846&_count=2"
}
],
"entry": [
{
"fullUrl": "https://api.haau3.com/v1/fhir/r4/Endpoint/Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358",
"resource": {
"resourceType": "Endpoint",
"id": "Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358",
"meta": {
"versionId": "1",
"lastUpdated": "2026-10-14T21:06:26.920943075Z",
"profile": [
"http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS",
"code": "complete",
"display": "Complete"
}
]
}
}
],
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "hl7-fhir-rest",
"display": "HL7 FHIR"
},
"managingOrganization": {
"reference": "Organization/Organization-1326655846"
},
"payloadType": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"version": "1.0.0",
"code": "not-applicable"
}
]
}
],
"address": "https://api.platform.athenahealth.com/22363/brand/1/csg/1/fhir/r4"
},
"search": {
"mode": "match"
}
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}Provider directory
Find endpoints
Search Endpoint by managing organization; connection-type, status and name narrow a search but cannot stand alone.
GET
/
v1
/
fhir
/
r4
/
Endpoint
cURL
curl "https://api.haau3.com/v1/fhir/r4/Endpoint?organization=Organization-1326655846&_count=2" \
-H "Authorization: Bearer $HAAU3_API_KEY"import { Haau3 } from "@haau3/sdk";
const haau3 = new Haau3(); // reads HAAU3_API_KEY
const bundle = await haau3.searchEndpoint({ organization: "Organization-1326655846", _count: 2 });
console.log(bundle.entry?.length ?? 0);
from haau3 import Haau3
client = Haau3() # reads HAAU3_API_KEY
bundle = client.search_endpoint(organization="Organization-1326655846", count=2)
print(len(bundle.get("entry", [])))
package main
import (
"context"
"fmt"
"log"
"github.com/haau3/haau3-go"
)
func main() {
ctx := context.Background()
client, err := haau3.NewClient() // reads HAAU3_API_KEY
if err != nil {
log.Fatal(err)
}
bundle, err := client.SearchEndpoint(ctx, haau3.SearchEndpointParams{Organization: new("Organization-1326655846"), Count: new(2)})
if err != nil {
log.Fatal(err)
}
fmt.Println(len(bundle.Entry))
}
{
"resourceType": "Bundle",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://api.haau3.com/v1/fhir/r4/Endpoint?organization=Organization-1326655846&_count=2"
}
],
"entry": [
{
"fullUrl": "https://api.haau3.com/v1/fhir/r4/Endpoint/Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358",
"resource": {
"resourceType": "Endpoint",
"id": "Endpoint-000508b0-e3f0-4108-8d1d-a610f0675358",
"meta": {
"versionId": "1",
"lastUpdated": "2026-10-14T21:06:26.920943075Z",
"profile": [
"http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"
]
},
"extension": [
{
"url": "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status",
"valueCodeableConcept": {
"coding": [
{
"system": "http://hl7.org/fhir/us/ndh/CodeSystem/NdhVerificationStatusCS",
"code": "complete",
"display": "Complete"
}
]
}
}
],
"status": "active",
"connectionType": {
"system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
"code": "hl7-fhir-rest",
"display": "HL7 FHIR"
},
"managingOrganization": {
"reference": "Organization/Organization-1326655846"
},
"payloadType": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"version": "1.0.0",
"code": "not-applicable"
}
]
}
],
"address": "https://api.platform.athenahealth.com/22363/brand/1/csg/1/fhir/r4"
},
"search": {
"mode": "match"
}
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}{
"resourceType": "OperationOutcome",
"issue": [
{
"severity": "fatal",
"code": "<string>",
"details": {
"text": "<string>"
},
"diagnostics": "<string>",
"expression": [
"<string>"
]
}
]
}Authorizations
Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.
Headers
An id of your own for this request, as a UUID. It comes back in the X-Correlation-Id header and is kept with haau3's record of the request. Any value that is not a UUID is ignored. See https://docs.haau3.com/errors#request-ids.
Query Parameters
The endpoints one organization manages. Give a Organization id, Organization/{id}, or the fullUrl this service returned. An address on another server is refused.
Required string length:
1 - 256A connection type from http://terminology.hl7.org/CodeSystem/endpoint-connection-type, bare or with that system: for example hl7-fhir-rest or direct-project. Narrows a search; cannot be used on its own.
Required string length:
1 - 256active, suspended, error, off, entered-in-error or test. Narrows a search; cannot be used on its own.
Required string length:
1 - 256Matches the endpoint's name. Narrows a search; cannot be used on its own, because most of the directory's endpoints share one name.
Required string length:
1 - 100Endpoint:organization brings the organization that manages each endpoint. Repeat the parameter to include several. Included entries do not count toward _count.
Required array length:
1 - 16 elementsAvailable options:
Endpoint:organization A Endpoint id. Searching by id rather than reading it lets one request also bring the records an _include or _revinclude names.
Pattern:
^[A-Za-z0-9\-.]{1,64}$count only: answers how many records match, as total, with no entries. Cannot be combined with _include, _revinclude, _count or page.
Available options:
count Results are paged. _count sets the page size (1 to 100); a larger value is refused rather than quietly reduced. Follow link with relation next to continue. The cursor it carries is opaque and must not be constructed or modified.
Required range:
1 <= x <= 100Continuation cursor. Opaque: follow the next link from a previous response, and never construct or modify it. Cursors expire.
Required string length:
1 - 8192