# List datasets metadata

Returns metadata for all available datasets. 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
Version: 26.2.0.4309
Security: Bearer

## Query parameters:

  - `tags` (array)
    If set, the result will contain items with matching associated tags. Currently supported tags are: "Sanctions and Exclusions", "Board Certifications", "NPI", "Id Check", "NPDB"

  - `entityTypes` (array)
    If set, the result will contain items that support the specified healthcare entity types.
    Enum: "Practitioner", "Facility"

  - `sortedBy` (string)
    The property by which the returned data will be sorted.
    Enum: "Name", "Type"

  - `sort` (object)
    If set, the properties and directions the returned data will be sorted by.

  - `cursor` (string)
    The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically.

  - `count` (integer)
    The number of items to include in a single page.

  - `sortDirection` (string)
    The direction the returned data will be sorted by.
    Enum: "Asc", "Desc"

  - `offset` (integer)
    The offset for the page to start.

## Response 200 fields (application/json):

  - `previousCursor` (string)
    The value to use for cursor to get to the previous paginated page. null will be returned if it's the first page.
    Example: "string"

  - `nextCursor` (string)
    The value to use for cursor to get to the next paginated page. null will be returned if it's the last page.
    Example: "string"

  - `pageSize` (integer)
    The maximum number of items included in this page.

  - `count` (integer)
    The number of items in this page.

  - `totalCount` (integer)
    The total number of items in all pages combined.

  - `items` (array)
    The event log entries in the current page.
    Example: [{"name":"string","type":"Sam","tags":["string"],"parameterSets":[{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","supportedParameterTypes":["Name"],"requiredParameterTypes":["Name"],"isPreferred":true}],"status":{"expectedProcessingTime":0},"monitoringIntervals":["Daily"],"lastUpdated":"2019-08-24T14:15:22.0000000Z","properties":{},"capabilities":{"property1":true,"property2":true},"maintenanceWindows":[{"expression":"string","description":"string"}],"hasPassThroughFee":false}]

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

  - `items.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"

  - `items.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"

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

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

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

  - `items.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"

  - `items.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"

  - `items.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).

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

  - `items.status` (object)

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

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

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

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

  - `items.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.

  - `items.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.

  - `items.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"

  - `items.capabilities.Values` (boolean)

  - `items.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.

  - `items.maintenanceWindows.expression` (string,null)

  - `items.maintenanceWindows.description` (string,null)

  - `items.maintenanceWindows.isUnderMaintenanceInTheNextHour` (boolean)

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

  - `items.maintenanceWindows.expiresIn` (string,null)

  - `items.maintenanceWindows.isExpired` (boolean,null)

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

  - `sortedBy` (string)
    The property by which the data is sorted.
    Enum: "Name", "Type"

  - `sortDirection` (string)
    The direction in which the data is sorted.
    Enum: "Asc", "Desc"

  - `sort` (object)
    The properties and directions the data is sorted by.
    Example: {"Name":"Asc","Type":"Desc"}

  - `sort.Keys` (string)
    Enum: "Name", "Type"

  - `nextOffset` (integer)
    The value to use for offset to get the next page following the current page or null if this page is the last.


## Response 401 fields

## Response 403 fields

## Response 500 fields