v1
latestOpenAPI 3.0.1Private2026-07-2212926.5 KBGet branding & metadata information associated with healthcare institutions supported by Fasten Connect.
brand_id OR portal_id is required.
<Note> This is used to display branding information in the Stitch.js popup widget. This API not required, unless you are building a custom widget. </Note> <Warning> **Do not call this endpoint live on every request.**Fasten may occasionally merge or deprecate IDs when the source EHR data changes or deletes records. To avoid broken references and improve performance:
- Cache the results returned by this endpoint.
- To check for updates, use the org_connection_id to call the status endpoint and retrieve the current brand_id and portal_id.
- Then, use those values to query the catalog GET endpoint and update your cached results accordingly.
Following this pattern ensures you always have the latest data without risking failures from deprecated IDs. </Warning>
<Badge color="green">TEFCA</Badge> If tefca_directory_id and brand_id are available, you should retrieve both. tefca_directory_id will provide an accurate name for the Healthcare Provider, while the brand_id can be used for logos and other branding information. However, if you can only retrieve one, prioritize tefca_directory_id.
TEFCA Directory IDs are subject to change by the TEFCA governing body and may be deprecated without notice. TEFCA Directory IDs are only cached for 2 weeks, after which they are removed from the catalog.
Query parameters
API Mode, used to filter institutions during lookup.
Public ID for Organization credential. See Authentication for more information
Portal ID (required if Brand ID or TEFCA Directory ID is not set)
Brand ID (required if Portal ID or TEFCA Directory ID is not set)
TEFCA Directory ID (required if Portal ID or Brand ID is not set)
Response
successful operation
Example response
{
"success": true,
"data": {
"id": "8d4136dd-31b6-4a65-88a0-7ea22a2b16d6",
"last_updated": "2024-04-03T10:00:00Z",
"name": "Acme Health, Inc.",
"portal_website": "https://www.example.com/privacy_policy",
"description": "Acme Health, Inc. is a leading provider of healthcare services in the United States.",
"endpoint_ids": [
"8d4136dd-31b6-4a65-88a0-7ea22a2b16d6"
]
}
}