Directory API

In this section, you can find guidance on how to search for the Directory's applications, endpoints, organizations, and application attestation information using API.

Applications and endpoints in the Directory are grouped by organizations that published them.

The base URL for accessing the Directory resources is the following:

https://endpointdirectory.caqh.org/api/epd/directory/search

Get Token

To access the Directory endpoints, you have to get the authorization token by sending the following request to the Authorization service:

POST https://auth.sandbox.kollab.link/auth/realms/main/protocol/openid-connect/token

The request body must contain the following data in the format x-www-form-urlencoded:

Key Sample Value Description
grant_type password Authorization client grant type
username your_email@mail.com The user name you use to sign in to the Directory
password Abcd123$ The password you use to sign in to the Directory
client_id epd-service-frontend Authorization client ID

Add the following script to the request, for the access token to be used as a global variable:

Copy 
var jsonData = pm.response.json();
console.log(jsonData);
postman.setGlobalVariable("access_token", jsonData.access_token); 
Copy 
pm.sendRequest({
      url:  "https://auth.sandbox.kollab.link/auth/realms/main/protocol/openid-connect/token", 
      method: 'POST',
      header: {
        'Accept': 'application/json',
        'Content-Type': 'application/x-www-form-urlencoded',
        'Authorization': 'Basic Abcdefghijk=='
      },
      body: {
          mode: 'urlencoded',
          urlencoded: [
            {key: "grant_type", value: "password", disabled: false},
            {key: "username", value: pm.globals.get("stagingDellUser"), disabled: false},
            {key: "password", value: pm.globals.get("stagingPassword"), disabled: false},
            {key: "client_id", value: pm.globals.get("epdClientId"), disabled: false},
        ]
      }
  }, function (err, res) {
        pm.environment.set("accountAuthToken", res.json().access_token);
  });

Search for Applications and Application Attestation Information

To get applications or/and application attestation information (the questions and responses in the section Attestation Information as part of the API response) of a certain organization from the Directory, send the following request:

GET https://endpointdirectory.caqh.org/api/epd/directory/search/applications

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/search/applications" -H "accept: application/json"

You can also search for applications by Application ID and Redirect URL, to do this, send the following requests:

GET https://endpointdirectory.caqh.org/api/epd/directory/search/applications?applicationId=value

GET https://endpointdirectory.caqh.org/api/epd/directory/search/applications?redirectUrl=value

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/search/applications?applicationId=value" -H "accept: application/json"

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/search/applications?redirectUrl=value" -H "accept: application/json"

Use the following request parameters:

Key Sample Value Parameter description
searchText app Text in the application's name or description to search by
organizationName best hospital Organization that published the application
organizationIds bh_1234 ID of the organization that published the application

Add the following request header with the access token as a global variable:

Key Value
Authorization Bearer {{access_token}}

If the operation is successful, you receive a response in the JSON format.

[

{

"about": "string",

"address": {

"city": "string",

"country": "string",

"postalCode": "string",

"province": "string",

"state": "string",

"street1": "string",

"street2": "string",

"zip": "string"

},

"applications": [

{

"about": "string",

"applicationUrl": "string",

"applicationVersion": "string",

"businessContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"description": "string",

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"name": "string",

"privacyPolicyUrl": "string",

"questionnaire": {},

"redirectUrls": [

"string"

],

"status": "Approved",

"supportedPlatforms": [

"Android"

],

"technicalContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"termsAndConditionUrl": "string"

}

],

"businessContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

"carinCodeAccepted": "boolean"

"submittedByContact": "contactDto"

},

"description": "string",

"endpoints": [

{

"absoluteUrl": "string",

"capabilityStatementUrl": "string",

"description": "string",

"environment": "Development",

"fhirVersion": "string",

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"name": "string",

"resources": [

{

"additionalFeatures": {

"conditionalCreate": true,

"conditionalDelete": "multiple",

"conditionalRead": "full-support",

"conditionalUpdate": true,

"readHistory": true,

"referencePolicy": [

"enforced"

],

"searchInclude": [

"string"

],

"searchRevInclude": [

"string"

],

"updateCreate": true,

"versioning": "no-version"

},

"interactions": [

"create"

],

"name": "string",

"profile": "string",

"searchParams": [

{

"description": "string",

"name": "string",

"type": "Composite"

}

]

}

],

"security": [

"Basic"

],

"status": "active"

}

],

"identifiers": [

{

"identifier": "string",

"qualifier": "string"

}

],

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"organizationName": "string",

"parentOrganization": "string",

"privacyPolicyUrl": "string",

"technicalContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"termsAndConditionUrl": "string",

"type": "string",

"websiteUrl": "string"

}

]

When a failure occurs, a JSON object with the error code and error message are returned.

Search for Endpoints

To get endpoints grouped by a certain organization from the Directory, send the following request:

GET https://endpointdirectory.caqh.org/api/epd/directory/search/endpoints

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/search/endpoints" -H "accept: application/json"

To get discovered endpoints, send the following request:

GET https://endpointdirectory.caqh.org/api/epd/directory/discovered-endpoints

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/discovered-endpoints" -H "accept: application/json"

You can also search for endpoints by Endpoint ID, to do this, send the following request:

GET https://endpointdirectory.caqh.org/api/epd/directory/search/endpoints?endpointId=value

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/search/endpoints?endpointId=value" -H "accept: application/json"

Use the following request parameters:

Key Sample Value Parameter description
searchText practitioner Text in the endpoint's name or description to search by
organizationName great payer The name of the organization that published the endpoint
organizationIds gp_123 ID of the organization that published the endpoint
fhirVersion 1.0 The supported FHIR version
resources Practitioner The resources supported by the endpoint
lineOfBusinesses medi Line of business
useCases formulary Use cases

Add the following request header with the access token as a global variable:

Key Value
Authorization Bearer {{access_token}}

If the operation is successful, you receive a response in the JSON format.

[

{

"about": "string",

"address": {

"city": "string",

"country": "string",

"postalCode": "string",

"province": "string",

"state": "string",

"street1": "string",

"street2": "string",

"zip": "string"

},

"applications": [

{

"about": "string",

"applicationUrl": "string",

"applicationVersion": "string",

"businessContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"description": "string",

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"name": "string",

"privacyPolicyUrl": "string",

"questionnaire": {},

"redirectUrls": [

"string"

],

"status": "Approved",

"supportedPlatforms": [

"Android"

],

"technicalContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"termsAndConditionUrl": "string"

}

],

"businessContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"description": "string",

"endpoints": [

{

"absoluteUrl": "string",

"capabilityStatementUrl": "string",

"description": "string",

"environment": "Development",

"fhirVersion": "string",

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"name": "string",

"resources": [

{

"additionalFeatures": {

"conditionalCreate": true,

"conditionalDelete": "multiple",

"conditionalRead": "full-support",

"conditionalUpdate": true,

"readHistory": true,

"referencePolicy": [

"enforced"

],

"searchInclude": [

"string"

],

"searchRevInclude": [

"string"

],

"updateCreate": true,

"versioning": "no-version"

},

"interactions": [

"create"

],

"name": "string",

"profile": "string",

"searchParams": [

{

"description": "string",

"name": "string",

"type": "Composite"

}

]

}

],

"security": [

"Basic"

],

"status": "active"

}

],

"identifiers": [

{

"identifier": "string",

"qualifier": "string"

}

],

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"organizationName": "string",

"parentOrganization": "string",

"privacyPolicyUrl": "string",

"technicalContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"termsAndConditionUrl": "string",

"type": "string",

"websiteUrl": "string"

}

]

When a failure occurs, a JSON object with the error code and error message are returned.

Search for Organizations

To get organizations with the Internal Revenue Service (IRS) registration documentation verified in a response as part of an organization profile from the Directory, send the following request:

GET https://endpointdirectory.caqh.org/api/epd/directory/search/organizations

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/search/organizations" -H "accept: application/json"

To get discovered organizations, send the following request:

GET https://endpointdirectory.caqh.org/api/epd/directory/discovered-organizations

Curl request: curl -X GET "https://endpointdirectory.caqh.org/api/epd/directory/discovered-organizations" -H "accept: application/json"

You can fetch a certain organization from the Directory based on the following items:

Key Sample Value Parameter description
searchText best hospital Text in the organization's name or description to search by
organizationIds bh_1234 ID of the organization
type vendor Organization type

Add the following request header with the access token as a global variable:

Key Value
Authorization Bearer {{access_token}}

If the operation is successful, you receive a response in the JSON format.

[

{

"about": "string",

"address": {

"city": "string",

"country": "string",

"postalCode": "string",

"province": "string",

"state": "string",

"street1": "string",

"street2": "string",

"zip": "string"

},

"applications": [

{

"about": "string",

"applicationUrl": "string",

"applicationVersion": "string",

"businessContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"description": "string",

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"name": "string",

"privacyPolicyUrl": "string",

"questionnaire": {},

"redirectUrls": [

"string"

],

"status": "Approved",

"supportedPlatforms": [

"Android"

],

"technicalContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"termsAndConditionUrl": "string"

}

],

"businessContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"description": "string",

"endpoints": [

{

"absoluteUrl": "string",

"capabilityStatementUrl": "string",

"description": "string",

"environment": "Development",

"fhirVersion": "string",

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"name": "string",

"resources": [

{

"additionalFeatures": {

"conditionalCreate": true,

"conditionalDelete": "multiple",

"conditionalRead": "full-support",

"conditionalUpdate": true,

"readHistory": true,

"referencePolicy": [

"enforced"

],

"searchInclude": [

"string"

],

"searchRevInclude": [

"string"

],

"updateCreate": true,

"versioning": "no-version"

},

"interactions": [

"create"

],

"name": "string",

"profile": "string",

"searchParams": [

{

"description": "string",

"name": "string",

"type": "Composite"

}

]

}

],

"security": [

"Basic"

],

"status": "active"

}

],

"identifiers": [

{

"identifier": "string",

"qualifier": "string"

}

],

"modifiedAt": "yyyy-MM-dd'T'HH:mm:ss'Z'",

"organizationName": "string",

"parentOrganization": "string",

"privacyPolicyUrl": "string",

"technicalContact": {

"email": "string",

"firstName": "string",

"lastName": "string",

"phone": "string",

"role": "string"

},

"termsAndConditionUrl": "string",

"type": "string",

"websiteUrl": "string"

}

]

When a failure occurs, a JSON object with the error code and error message are returned.