Make A Test Call

Once you have your access token, you can navigate to the API Reference page to try out the endpoint of your choice. The process for any endpoint is similar, but this example will walk through authenticating and calling our Provider Lookup using a Type 1 (provider) NPI.

Authorization

Under the AUTHORIZATION section, paste your access token from the previous step in the Bearer field.

Enter an NPI

Then enter a Type 1 NPI (such as 1922037787) in the npi field, then click Try It!

Response

Your JSON response will appear under the RESPONSE section and will look something like this:

{
  "active": true,
  "affiliatedOrganizations": {
    "items": [
      {
        "id": "string",
        "name": "string",
        "parentId": "string"
      }
    ]
  },
  "affiliatedPractices": {
    "items": [
      {
        "address": {
          "city": "string",
          "county": "string",
          "state": "string",
          "street": "string",
          "zipCode": "string"
        },
        "latLong": {
          "lat": 0,
          "long": 0
        },
        "percentOfVisits": 0,
        "phoneNumber": "string",
        "visitsDistribution": {
          "visitsPercentFri": 0,
          "visitsPercentMon": 0,
          "visitsPercentSat": 0,
          "visitsPercentSun": 0,
          "visitsPercentThu": 0,
          "visitsPercentTue": 0,
          "visitsPercentWed": 0
        },
        "workType": "string",
        "wrvuSummary": {
          "averageCurrentYear": 0,
          "averagePreviousYear": 0,
          "averageTwoYearsAgo": 0,
          "totalCurrentYear": 0,
          "totalPreviousYear": 0,
          "totalTwoYearsAgo": 0
        }
      }
    ],
    "total": 0
  },
  "credential": "string",
  "estimatedAge": 0,
  "gender": "string",
  "medicalSchool": {
    "graduationYear": "string",
    "name": "string"
  },
  "name": {
    "first": "string",
    "full": "string",
    "last": "string",
    "middle": "string",
    "suffix": "string"
  },
  "npi": "string",
  "patientPanel": {
    "age": {
      "median": 0,
      "percent0to19": 0,
      "percent20to44": 0,
      "percent45to64": 0,
      "percent65to84": 0,
      "percent85Plus": 0
    },
    "gender": {
      "percentFemale": 0,
      "percentMale": 0
    },
    "size": 0
  },
  "planNames": [
    "string"
  ],
  "primarySpecialty": {
    "code": "string",
    "description": "string"
  },
  "topReferrals": {
    "referredFrom": [
      {
        "count": 0,
        "name": "string",
        "npi": 0,
        "specialty": "string"
      }
    ],
    "referredTo": [
      {
        "count": 0,
        "name": "string",
        "npi": 0,
        "specialty": "string"
      }
    ]
  },
  "visitsStatistics": {
    "percentCommercial": 0,
    "percentMedicaid": 0,
    "percentMedicareAdvantage": 0,
    "percentMedicareTraditional": 0,
    "topDiagnoses": [
      "string"
    ],
    "topProcedures": [
      "string"
    ],
    "total": 0
  },
  "wrvuSummary": {
    "averageCurrentYear": 0,
    "averagePreviousYear": 0,
    "averageTwoYearsAgo": 0,
    "totalCurrentYear": 0,
    "totalPreviousYear": 0,
    "totalTwoYearsAgo": 0
  }
}