# Get dataset metadata

Returns metadata for a specific dataset. The metadata includes the date it was last updated in our system in addition to the JSON schema used for the records.

Endpoint: GET /datasets/{datasetType}
Version: 26.2.0.4309
Security: Bearer

## Path parameters:

  - `datasetType` (string, required)
    The specific dataset type to get the metadata for.
    Enum: "Sam", "MedicareOptOut", "OigFugitives", "OfacSdn", "OfacConsolidated", "OigExclusions", "StateSanctionsAndExclusions", "Npdb", "Dmf", "Npi", "Nsc", "Dea", "CmsPreclusion", "Tricare", "AmericanBoardofInternalMedicine", "NationalCommissiononCertificationofPhysicianAssistants", "Abms", "NationalBoardforCertifiedCounselors", "AmericanAcademyofNursePractitioners", "NationalBoardofCertificationandRecertificationforNurseAnesthetists", "AmericanOsteopathicAssociation", "AmericanNursesCredentialingCenter", "NationalBoardforCertificationinOccupationalTherapy", "AmericanSpeechLanguageHearingAssociation", "AmericanBoardofFamilyMedicine", "AmericanBoardofPsychiatryandNeurology", "InternationalBoardofLactationConsultantExaminers", "AmericanMidwiferyCertificationBoard", "AmericanDentalBoardofAnesthesiology", "AmericanBoardofClinicalSocialWork", "BoardOfPharmacySpecialties", "AmericanBoardofAllergyandImmunology", "AmericanBoardofOrthodontics", "AmericanBoardofOralMedicine", "AmericanBoardofPediatricDentistry", "AmericanBoardofOralandMaxillofacialSurgery", "AmericanBoardofOralandMaxillofacialRadiology", "AmericanBoardofProsthodontics", "AmericanBoardofOralandMaxillofacialPathology", "AmericanBoardofEndodontics", "AmericanBoardofPeriodontology", "AmericanBoardofOralImplantology", "AmericanBoardofPodiatricMedicine", "AmericanBoardofDentalPublicHealth", "BehaviorAnalystCertificationBoard", "AmericanBoardofGeneralDentistry", "NationalAssociationofSchoolPsychologists", "AmericanBoardofAddictionMedicine", "AmericanBoardofMultipleSpecialtiesinPodiatry", "CommissionOnDieteticRegistration", "AmericanBoardOfObesityMedicine", "NationalCertificationCorporation", "NationalCommissionForCertificationOfAnesthesiologistAssistants", "AmericanRegistryOfRadiologyTechnologists", "AmericanBoardOfAnesthesiology", "AmericanRegistryForDiagnosticMedicalSonography", "NationalBoardOfPhysiciansAndSurgeons", "CardiovascularCredentialingInternational", "NationalCenterForCompetencyTesting", "NationalAssociationOfPhlebotomyTechnicians", "AmericanAlliedHealth", "NationalRegistryOfAlliedHealthProfessionals", "AmericanMedicalTechnologists", "NationalHealthCareerAssociation", "DentalAssistingNationalBoard", "PediatricNursingCertification", "NationalCertificationCommissionForAcupunctureAndOrientalMedicine", "CertificationBoardForMusicTherapists", "AmericanBoardOfChiropracticInternists", "AmericanBoardofPhysicalTherapySpecialties", "AmericanBoardofPhysicianSpecialties", "AmericanAcademyofOptometry", "AmericanBoardofNeurologicalSurgery", "AmericanBoardofObstetricsandGynecology", "AmericanBoardofOphthalmology", "AmericanBoardofOtolaryngologyHeadandNeckSurgery", "AmericanBoardofPediatrics", "AmericanBoardofOrthopaedicSurgery", "AmericanBoardofPhysicalMedicineandRehabilitation", "AmericanBoardofPlasticSurgery", "AmericanBoardofRadiology", "AmericanBoardofSurgery", "AmericanBoardofUrology", "AmericanBoardofColonandRectalSurgery", "AmericanAssociationofCriticalCareNurses", "AmericanBoardofFootandAnkleSurgery", "PharmacyTechnicianCertificationBoard", "NationalBoardofSurgicalTechnologyandSurgicalAssisting", "AmericanBoardofPainMedicine", "AmericanBoardofOrofacialPain", "NuclearMedicineTechnologyCertificationBoard", "AmericanBoardofEmergencyMedicine", "ArtTherapyCredentialsBoard", "AmericanHeartAssociation", "MedicaidEnrollmentCalifornia", "JointCommission", "FacilityCmsCertification"

## Response 200 fields (application/json):

  - `name` (string)
    Non-technical, display friendly, name for this dataset.

  - `type` (string)
    The dataset type to which this metadata applies.
    Enum: "Sam", "MedicareOptOut", "OigFugitives", "OfacSdn", "OfacConsolidated", "OigExclusions", "StateSanctionsAndExclusions", "Npdb", "Dmf", "Npi", "Nsc", "Dea", "CmsPreclusion", "Tricare", "AmericanBoardofInternalMedicine", "NationalCommissiononCertificationofPhysicianAssistants", "Abms", "NationalBoardforCertifiedCounselors", "AmericanAcademyofNursePractitioners", "NationalBoardofCertificationandRecertificationforNurseAnesthetists", "AmericanOsteopathicAssociation", "AmericanNursesCredentialingCenter", "NationalBoardforCertificationinOccupationalTherapy", "AmericanSpeechLanguageHearingAssociation", "AmericanBoardofFamilyMedicine", "AmericanBoardofPsychiatryandNeurology", "InternationalBoardofLactationConsultantExaminers", "AmericanMidwiferyCertificationBoard", "AmericanDentalBoardofAnesthesiology", "AmericanBoardofClinicalSocialWork", "BoardOfPharmacySpecialties", "AmericanBoardofAllergyandImmunology", "AmericanBoardofOrthodontics", "AmericanBoardofOralMedicine", "AmericanBoardofPediatricDentistry", "AmericanBoardofOralandMaxillofacialSurgery", "AmericanBoardofOralandMaxillofacialRadiology", "AmericanBoardofProsthodontics", "AmericanBoardofOralandMaxillofacialPathology", "AmericanBoardofEndodontics", "AmericanBoardofPeriodontology", "AmericanBoardofOralImplantology", "AmericanBoardofPodiatricMedicine", "AmericanBoardofDentalPublicHealth", "BehaviorAnalystCertificationBoard", "AmericanBoardofGeneralDentistry", "NationalAssociationofSchoolPsychologists", "AmericanBoardofAddictionMedicine", "AmericanBoardofMultipleSpecialtiesinPodiatry", "CommissionOnDieteticRegistration", "AmericanBoardOfObesityMedicine", "NationalCertificationCorporation", "NationalCommissionForCertificationOfAnesthesiologistAssistants", "AmericanRegistryOfRadiologyTechnologists", "AmericanBoardOfAnesthesiology", "AmericanRegistryForDiagnosticMedicalSonography", "NationalBoardOfPhysiciansAndSurgeons", "CardiovascularCredentialingInternational", "NationalCenterForCompetencyTesting", "NationalAssociationOfPhlebotomyTechnicians", "AmericanAlliedHealth", "NationalRegistryOfAlliedHealthProfessionals", "AmericanMedicalTechnologists", "NationalHealthCareerAssociation", "DentalAssistingNationalBoard", "PediatricNursingCertification", "NationalCertificationCommissionForAcupunctureAndOrientalMedicine", "CertificationBoardForMusicTherapists", "AmericanBoardOfChiropracticInternists", "AmericanBoardofPhysicalTherapySpecialties", "AmericanBoardofPhysicianSpecialties", "AmericanAcademyofOptometry", "AmericanBoardofNeurologicalSurgery", "AmericanBoardofObstetricsandGynecology", "AmericanBoardofOphthalmology", "AmericanBoardofOtolaryngologyHeadandNeckSurgery", "AmericanBoardofPediatrics", "AmericanBoardofOrthopaedicSurgery", "AmericanBoardofPhysicalMedicineandRehabilitation", "AmericanBoardofPlasticSurgery", "AmericanBoardofRadiology", "AmericanBoardofSurgery", "AmericanBoardofUrology", "AmericanBoardofColonandRectalSurgery", "AmericanAssociationofCriticalCareNurses", "AmericanBoardofFootandAnkleSurgery", "PharmacyTechnicianCertificationBoard", "NationalBoardofSurgicalTechnologyandSurgicalAssisting", "AmericanBoardofPainMedicine", "AmericanBoardofOrofacialPain", "NuclearMedicineTechnologyCertificationBoard", "AmericanBoardofEmergencyMedicine", "ArtTherapyCredentialsBoard", "AmericanHeartAssociation", "MedicaidEnrollmentCalifornia", "JointCommission", "FacilityCmsCertification"

  - `tags` (array)
    Tags associated to this dataset. Tags are used to group or identity the similar datasets. Currently supported tags are: "Sanctions and Exclusions", "Board Certifications", "NPI"

  - `parameterSets` (array)
    Array of parameter sets that are supported by this dataset

  - `parameterSets.id` (string)
    Unique identifier for this parameter set.

  - `parameterSets.entityType` (string)
    The healthcare entity type that this parameter set is for.
    Enum: "Practitioner", "Facility"

  - `parameterSets.supportedParameterTypes` (array)
    Array of parameter types that are supported by the dataset during a scan.
    Enum: "Name", "Npi", "DateOfBirth", "Ssn", "License", "Address", "Education", "BoardCertificationNumber", "Dea", "Certificate", "CaqhId", "ProviderType", "FacilityName", "FacilityAccreditationInfo", "FacilityCmsCertificationInfo", "NccpaBoardCertificateInfo", "Gender"

  - `parameterSets.requiredParameterTypes` (array)
    Array of parameter types that are required by this dataset for the scans to execute. If these parameters cannot be resolved, the scan will fail.
    Enum: "Name", "Npi", "DateOfBirth", "Ssn", "License", "Address", "Education", "BoardCertificationNumber", "Dea", "Certificate", "CaqhId", "ProviderType", "FacilityName", "FacilityAccreditationInfo", "FacilityCmsCertificationInfo", "NccpaBoardCertificateInfo", "Gender"

  - `parameterSets.isPreferred` (boolean)
    Set to true if this parameter set will be used to run a scan if no parameter set is specified when initiating a [dataset scan](/references/api/datasets/startdatasetscan).

  - `supportedEntityTypes` (array)
    Array of healthcare entity types that are supported by this dataset.
    Enum: "Practitioner", "Facility"

  - `status` (object)

  - `status.expectedProcessingTime` (number)
    The duration in seconds it may take to complete a dataset scan from start to end.

  - `monitoringIntervals` (array)
    The intervals at which the dataset is being monitored.
    Enum: "Continuous", "Daily", "Weekly", "Monthly", "Yearly"

  - `lastUpdated` (string)
    Timestamp on when the dataset was last updated.

  - `schema` (any)
    The JSON schema of the records in this dataset. The models can also be found [here](/references/api/Dataset-Records).

  - `properties` (object)
    Any additional properties associated with this dataset. For example, StateSanctionsAndExclusions provides the list of primary source(s) this dataset encapsulates via the Sources property.

  - `capabilities` (object)
    Indicates the capabilities for this dataset. Currently the only capability that can differ per dataset is if records can be ignored or not.

  - `capabilities.Keys` (string)
    * SupportsMultipleMonitors - Indicates whether the dataset supports multiple monitoring configurations.
* SupportsReferences - Indicates if the Dataset uses a referenceId as a trigger for the scan.
* SupportsAliases - Indicates if the dataset can utilize provider aliases to identify matches.
* SupportsMatchRelevance - Indicates if the dataset supports the MatchRelevancePreference to adjust match accuracy.
* SupportsContinuousMonitoring - Currently unique to the NPDB dataset, indicates if continuous monitoring is available.
* SupportsOnDemandScanning - Indicates whether the dataset allows scans to be triggered on demand and in multiple instances.
* SupportsMonitoring - Indicates if a monitor can be created.
    Enum: "SupportsMultipleMonitors", "SupportsReferences", "SupportsAliases", "SupportsMatchRelevance", "SupportsContinuousMonitoring", "SupportsOnDemandScanning", "SupportsMonitoring"

  - `capabilities.Values` (boolean)

  - `maintenanceWindows` (array)
    Array with the CRON descriptions that explain when this dataset type will be in maintenance window. When a dataset is in a maintenance window the requests sent to it will be delayed until it is over.

  - `maintenanceWindows.expression` (string,null)

  - `maintenanceWindows.description` (string,null)

  - `maintenanceWindows.isUnderMaintenanceInTheNextHour` (boolean)

  - `maintenanceWindows.trigger` (string)
    Enum: "Manual", "Automated"

  - `maintenanceWindows.expiresIn` (string,null)

  - `maintenanceWindows.isExpired` (boolean,null)

  - `hasPassThroughFee` (boolean)
    Indicates whether the dataset source charges a pass-through fee for a verification.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 409 fields

## Response 500 fields