Skip to main content
GET
cURL

Query Parameters

api_mode
string
required

API Mode, used to filter institutions during lookup.

public_id
string
required

Public ID for Organization credential. See Authentication for more information

portal_id
string

Portal ID (required if Brand ID or TEFCA Directory ID is not set)

brand_id
string

Brand ID (required if Portal ID or TEFCA Directory ID is not set)

tefca_directory_id
string

TEFCA Directory ID (required if Portal ID or Brand ID is not set)

Response

200 - application/json

successful operation

success
boolean
Example:

true

error
string
Example:

""

data
object

Patient Portal information for a healthcare institution