> ## Documentation Index > Fetch the complete documentation index at: https://docs.haau3.com/llms.txt > Use this file to discover all available pages before exploring further. # Find endpoints > Search `Endpoint` by managing organization; `connection-type`, `status` and `name` narrow a search but cannot stand alone. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/fhir/r4/Endpoint openapi: 3.1.0 info: title: haau3 Platform API version: 1.0.0-preview.4 description: >- The haau3 platform API is in preview: it may change as we build, usually to add features or improve performance. Endpoints require an API key, sent as `Authorization: Bearer `. Requests without a valid key return 401. Create a key in the dashboard at https://platform.haau3.com; a new organization starts on the free Developer plan. From 2026-11-01 a request past one of its plan's limits (requests a minute on every plan, requests a month on Developer) returns 429 with `Retry-After`. Every error under `/v1/fhir` is a FHIR `OperationOutcome` and every other error an RFC 9457 problem; https://docs.haau3.com/errors lists every status, whether to retry it, and what a method a path does not take answers. servers: - url: https://api.haau3.com description: Production security: - bearerAuth: [] tags: - name: Scheduling description: 'Provider availability (SMART Scheduling Links): slots and publishers.' - name: FHIR base description: >- What the FHIR R4 base at `/v1/fhir/r4` answers for every service on it: the `CapabilityStatement` that lists them all, and batch Bundles that carry several requests to any of them in one round trip. - name: Terminology description: >- FHIR terminology operations over the code systems listed in TerminologyCapabilities. Some are resolved from their own source when you ask; others are held here at a named release, which that resource also names. - name: Provider directory description: >- CMS's National Provider Directory as FHIR R4: practitioners and their roles, organizations, payers and insurance networks, network membership, healthcare services, locations and endpoints. Every parameter the service serves is declared here, and any other is refused by name rather than ignored. - name: Questionnaires description: >- FHIR Questionnaire, served as its source publishes it. This service holds copies of a curated set and reaches any other questionnaire its source publishes by canonical URL, as well as forms published at their own address under places this service is set up to reach. Read one by id, and build the QuestionnaireResponse in your own application. - name: Plan Benefits description: >- FHIR InsurancePlan: what a Medicare Advantage or ACA Marketplace plan covers and what a member pays, read from the files CMS publishes. Every plan names the CMS release it was read from. Read a plan by its id, or search by identifier, name, state or county, and check whether the CMS National Provider Directory lists providers in a plan's network. - name: MedList description: >- One reconciled medication list from one patient's FHIR medication records, as US Core MedicationRequests with a Provenance for each. This operation receives patient data, so send it only under an executed agreement. paths: /v1/fhir/r4/Endpoint: get: tags: - Provider directory summary: Find endpoints description: >- Search `Endpoint` by managing organization; `connection-type`, `status` and `name` narrow a search but cannot stand alone. operationId: searchEndpoint parameters: - name: organization in: query required: false schema: type: string minLength: 1 maxLength: 256 description: >- The endpoints one organization manages. Give a Organization id, `Organization/{id}`, or the `fullUrl` this service returned. An address on another server is refused. example: Organization-1326655846 - name: connection-type in: query required: false schema: type: string minLength: 1 maxLength: 256 description: >- A 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. - name: status in: query required: false schema: type: string minLength: 1 maxLength: 256 description: >- `active`, `suspended`, `error`, `off`, `entered-in-error` or `test`. Narrows a search; cannot be used on its own. - name: name in: query required: false schema: type: string minLength: 1 maxLength: 100 description: >- Matches the endpoint's name. Narrows a search; cannot be used on its own, because most of the directory's endpoints share one name. - name: _include in: query required: false schema: minItems: 1 maxItems: 16 type: array items: type: string enum: - Endpoint:organization style: form explode: true description: >- `Endpoint:organization` brings the organization that manages each endpoint. Repeat the parameter to include several. Included entries do not count toward `_count`. - name: _id in: query required: false schema: type: string pattern: ^[A-Za-z0-9\-.]{1,64}$ description: >- A Endpoint id. Searching by id rather than reading it lets one request also bring the records an `_include` or `_revinclude` names. - name: _summary in: query required: false schema: type: string enum: - count description: >- `count` only: answers how many records match, as `total`, with no entries. Cannot be combined with `_include`, `_revinclude`, `_count` or `page`. - name: _count in: query required: false schema: type: integer minimum: 1 maximum: 100 description: >- 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. example: 2 - name: page in: query required: false schema: type: string minLength: 1 maxLength: 8192 description: >- Continuation cursor. Opaque: follow the `next` link from a previous response, and never construct or modify it. Cursors expire. - $ref: '#/components/parameters/XRequestId' responses: '200': description: >- A FHIR `Bundle` with `type: searchset`. `total` is present when the directory sends one. content: application/fhir+json: schema: $ref: '#/components/schemas/Bundle' examples: An organization's endpoints: summary: An organization's endpoints value: 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 headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '400': description: >- The request named a parameter, identifier system or value this service does not serve. Every unsupported parameter is refused by name, and none is silently ignored, so a search that returns results applied every filter you sent. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '401': $ref: '#/components/responses/FhirUnauthorized' '404': description: No such resource, or no such interaction on this base. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '406': $ref: '#/components/responses/FhirNotAcceptable' '429': $ref: '#/components/responses/FhirTooManyRequests' '500': $ref: '#/components/responses/FhirServerError' '502': description: >- The directory could not be reached, answered in a shape that cannot be served, or answered with more than is served at once: a `_revinclude` past the directory's 100 records on a page, or an answer over 8 MiB. No answer is given: this is never reported as an empty result, which would read as 'no such provider'. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '503': description: >- The directory is rate limiting requests. Send the request again after `Retry-After`. It is also the answer when the API key could not be checked just now, with `Retry-After`. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: Retry-After: description: >- Sent when waiting will help: the API key could not be checked just now, or the source behind this service is rate limiting requests. How many seconds to wait before sending the request again. schema: type: integer minimum: 0 X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' '504': description: The directory did not respond in time. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' x-codeSamples: - lang: bash label: cURL source: > curl "https://api.haau3.com/v1/fhir/r4/Endpoint?organization=Organization-1326655846&_count=2" \ -H "Authorization: Bearer $HAAU3_API_KEY" - lang: typescript label: TypeScript source: > 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); - lang: python label: Python source: > from haau3 import Haau3 client = Haau3() # reads HAAU3_API_KEY bundle = client.search_endpoint(organization="Organization-1326655846", count=2) print(len(bundle.get("entry", []))) - lang: go label: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\t\"github.com/haau3/haau3-go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient, err := haau3.NewClient() // reads HAAU3_API_KEY\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tbundle, err := client.SearchEndpoint(ctx, haau3.SearchEndpointParams{Organization: new(\"Organization-1326655846\"), Count: new(2)})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Println(len(bundle.Entry))\n}\n" components: parameters: XRequestId: name: X-Request-Id in: header required: false schema: type: string format: uuid description: >- 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. schemas: Bundle: type: object description: A FHIR R4 [Bundle](https://hl7.org/fhir/R4/bundle.html). properties: resourceType: type: string const: Bundle type: type: string entry: type: array items: type: object additionalProperties: true required: - resourceType additionalProperties: true OperationOutcome: type: object description: >- A FHIR R4 [OperationOutcome](https://hl7.org/fhir/R4/operationoutcome.html). properties: resourceType: type: string const: OperationOutcome issue: type: array items: type: object properties: severity: type: string enum: - fatal - error - warning - information code: type: string details: type: object properties: text: type: string additionalProperties: true diagnostics: type: string expression: type: array items: type: string required: - severity - code additionalProperties: true required: - resourceType - issue headers: XRequestId: description: >- The id haau3 gave this request, a UUID, on every response. Quote it in a question about the response. A problem carries the same id as its `instance`. schema: type: string format: uuid XCorrelationId: description: The `X-Request-Id` you sent, when it was a UUID. schema: type: string format: uuid responses: FhirUnauthorized: description: Missing or invalid API key. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: WWW-Authenticate: description: >- The scheme to authenticate with: `Bearer realm="api.haau3.com"`, with `error="invalid_token"` when a key was sent and not recognised. schema: type: string X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirNotAcceptable: description: >- The request asked for a format other than JSON (`Accept` or `_format`), or for a FHIR release this endpoint does not serve (the `fhirVersion` media-type parameter). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirTooManyRequests: description: >- A limit of the organization's plan was reached: its requests a minute, or the Developer plan's requests a month. Send the request again after `Retry-After`, which for the monthly limit runs to the 1st of the next month (UTC). content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: Retry-After: description: How many seconds to wait before sending the request again. schema: type: integer minimum: 0 X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' FhirServerError: description: The server failed to process this request. content: application/fhir+json: schema: $ref: '#/components/schemas/OperationOutcome' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-Correlation-Id: $ref: '#/components/headers/XCorrelationId' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your platform API key (`haau3_sk_…`), sent as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.