Sign in

v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB
v2/providers

Lists all providers in an organization

Fetches all the providers in the given organization, this endpoint is used to query for all providers in the organization. The endpoint returns a list of providers with the providerId and basic details. This endpoint supports filters for pagination (offset and limit), file type, flagged status, and created or updated date ranges. The practice location data response can be enabled on request, it is not returned by default.

get/v2/providers

Query parameters

offsetnumber

The starting index for pagination, specifying how many records to skip.

limitnumber

The maximum number of records to retrieve in a single request.

file_type'Clean' | 'Non_Clean' | 'Pending'

File Type of the providers to filter by to be terminated.

flaggedboolean

Flagged providers will be terminated.

start_updated_atstring date-time

Filter providers that are created or updated >= specified date.

end_updated_atstring date-time

Filter providers that are created or updated < specified date.

Headers

organization-idstring

Response

List of providers.

first_namestring required
middle_namestring required
last_namestring required
npistring required
degreestring required
provider_idstring required
created_atstring date-time required
updated_atstring date-time required
status'Terminated' | 'Active' | 'Denied' | 'New' | 'In Progress' required

Current status of the provider

credentialing_status'Not sent to credentialing' | 'Not Started' | 'In Progress' | 'Recredentialing in progress' | 'Data missing' | 'Outreach in progress' | 'PSV Complete' | 'PSV ready' | 'Hold for Cred Comm' | 'Tabled' | 'Cred approved' | 'Cred denied' | 'Provider Terminated' | 'Withdrawn/Cancelled' | 'Credentialing restarted' | 'PSV complete by CertifyOS' required

Credentialing status of the provider

credentialing_status_update_datestring required
external_idstring required
gender'Male' | 'Female' | 'Not Listed/Unknown' required

Gender of the provider

primary_emailstring required
caqh_primary_emailstring required
dobstring required
isHospitalBasedboolean required

Example response

[
  {
    "credentialing_status_update_date": "YYYY-MM-DD",
    "dob": "YYYY-MM-DD",
    "practice_location": [
      {
        "start_date": "YYYY-MM-DD",
        "clia_expiration_date": "YYYY-MM-DD",
        "verified_date": "YYYY-MM-DD"
      }
    ]
  }
]