latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Flag

Get all flags (All Sections tab)

Returns a paginated, tenant-scoped list of flags across all record types. Equivalent to the All Sections tab on the flags landing page. Common columns only — no metaData block. Client (non-certifyos.com) users are restricted to Open flags by default.

get/flags

Query parameters

endAtIdstring

Cursor: end at this flag id (backward pagination)

filterstring

Filter criteria as a URL-encoded JSON object — {"<key>": {"<operator>": <value>}}. Keys are ANDed. Each value is an operator object forwarded to the DAL unchanged (e.g. {"eq":"open"}, {"in":["open","seen"]}, {"gte":"2026-01-01","lte":"2026-12-31"}). Recognised keys, translated server-side to their DAL field: exclusionType, flagType, metaData.actionType, metaData.aggregateCoverageAmount, metaData.databankSubjectId, metaData.enrollmentStatus.status, metaData.enumerationType, metaData.expiration, metaData.expirationDate, metaData.expiryDate, metaData.firstName, metaData.flaggedDate, metaData.homeState, metaData.lastActionDate, metaData.lastName, metaData.licenseNumber, metaData.licenseSource, metaData.licenseStatus, metaData.licenseType, metaData.middleName, metaData.moc, metaData.npi, metaData.npiStatus, metaData.number, metaData.occuranceCoverageAmount, metaData.parsedData.exclusionType, metaData.parsedData.sanctionEndDate, metaData.policyNumber, metaData.processDate, metaData.reportDate, metaData.reportType, metaData.sanctionStartDate, metaData.sanctionType, metaData.source, metaData.sourceUpdateDate, metaData.speciality, metaData.state, metaData.status, metaData.typeOfAction, nppesFirst, nppesLast, nppesMiddle, nppesNpi, nppesNpiStatus, recordType, sanctionEndDate, sanctionType, status. daysUntilExpiration is synthetic: supply numeric day offsets via gte/gt/lte/lt/eq and the server translates them into an absolute data.metaData.expiration date range. Any other key is forwarded verbatim, so already-qualified data. / data.metaData. DAL fields work too. tenantId is dropped — the tenant-id header wins. Server-forced clauses always override a colliding key: tenant isolation, the recordType/sanctionType locks, the client-user default of status = open, and — for callers lacking the needs-verification permission — the needsVerification status and internal-only flagType exclusions. A value that is not a JSON object, or that fails to parse, is ignored and the server defaults apply.

orderstring

Sort specification as a URL-encoded JSON object — {"orderBy": "<field>", "orderByDirection": "asc"|"desc"}. Accepted orderBy aliases: actionState, actionType, board, cmsEffectiveDate, cmsPreclusionReason, createdAt, credentialingStatus, dataSection, dataSource, daysUntilExpiration, effectiveDate, enumerationType, exclusionType, expiration, expirationDate, firstName, flagMdSanctionType, flagRecordType, flagStatus, flagType, flaggedDate, lastActionDate, lastName, licenseNumber, licenseSource, licenseState, licenseStatus, licenseType, middleName, mooEndDate, npi, npiStatus, nppesEnumerationType, nppesFirst, nppesLast, nppesMiddle, nppesNpi, nppesNpiStatus, oigExclusionDate, oigExclusionType, practitioner, recordType, reportDate, samExclusionDate, samExclusionType, samTerminationDate, sanctionEndDate, sanctionStartDate, sanctionType, sourceFlaggedOn, sourceUpdateDate, stateMedicaidEffectiveDate, stateMedicaidEndDate, stateMedicaidSanctionType, status, updatedAt, updatedOn. DAL field names are accepted directly as well: createdAt, credentialingStatus, data.metaData.actionType, data.metaData.enumerationType, data.metaData.expiration, data.metaData.firstName, data.metaData.flaggedDate, data.metaData.lastActionDate, data.metaData.lastName, data.metaData.licenseNumber, data.metaData.licenseSource, data.metaData.licenseStatus, data.metaData.licenseType, data.metaData.middleName, data.metaData.npi, data.metaData.npiStatus, data.metaData.parsedData.exclusionType, data.metaData.parsedData.sanctionEndDate, data.metaData.reportDate, data.metaData.sanctionStartDate, data.metaData.sanctionType, data.metaData.source, data.metaData.sourceUpdateDate, data.metaData.state, data.metaData.typeOfAction, data.recordType, data.status, dataSource, flagTypeId, practitionerFirstName, practitionerLastName, practitionerNpi, updatedAt, as is a metaData.<field> shorthand for any allowlisted data.metaData.<field>. orderByDirection defaults to desc when omitted or blank. An unknown or unresolvable orderBy is not an error: the tab default sort below is applied instead. Default when order is omitted: {"orderBy":"data.metaData.flaggedDate","orderByDirection":"desc"}.

pageinteger

0-based page number

recordTypestring[]

Record types to include (repeatable or comma-separated), matched with IN. Accepted values: state-licenses, dea-data, cds-data, board-certifications, malpractice-insurances, npdb-data, licensure-actions, sanctions, nppes. When 'sanctions' is included, sanctionType is required.

sanctionTypestring[]

Sanctions sub-tabs (repeatable or comma-separated), matched with IN (OFAC|MOO|STATE_SANCTIONS|OIG|CLIENT_PRECLUSIONS|SAM); required when recordType includes 'sanctions', otherwise ignored

size10 | 25 | 50 | 100

Page size. One of 10, 25, 50, 100; defaults to 10. Any other value is rejected with 400 INVALID_PAGE_SIZE.

startAfterIdstring

Cursor: start after this flag id (forward pagination)

Headers

tenant-idstring required

Tenant ID

Response

Successfully retrieved flags

totalCountinteger

Total number of flags matching the query

Example response

{
  "totalCount": 137,
  "data": [
    {
      "recordType": "state-licenses",
      "flagType": "expired",
      "status": "open",
      "flaggedDate": "2026-06-15",
      "updatedOn": "2026-06-28T04:12:00Z",
      "dataSource": "certify-scraper",
      "practitioner": {
        "prefix": "Dr.",
        "firstName": "Jane",
        "middleName": "A",
        "lastName": "Doe",
        "npi": "1234567890",
        "providerType": [
          "MD"
        ],
        "statesToCredential": [
          "CA",
          "NY"
        ],
        "credentialingStatus": "CRED_APPROVED",
        "dateOfBirth": "1980-05-04",
        "email": "jane.doe@example.com",
        "lastCredentialedDate": "2024-11-02"
      },
      "createdAt": "2026-01-15T10:00:00Z",
      "markedSeenAt": "2026-02-01T00:00:00Z",
      "markedSeenBy": "Jane Doe",
      "originMonitoringWorkflowId": "wf-123"
    }
  ]
}