Sign in

v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB
v2/flags

Search provider flags

Returns a list of provider flags based on advanced filter criteria. Supports filtering by NPI, flag type, name, sub-collection, committee sharing, read status, and date ranges.

get/v2/flags/search

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.

npistring

Provider NPI

flag_typestring[]

Type of flag

first_namestring

First name

last_namestring

Last name

sub_collection_namestring[]

Sub collection name

shared_to_cred_committeeboolean

Shared to cred committee (boolean)

flagReadStatus'seen' | 'unseen' | 'all'

Flag read status (seen, unseen, all)

flagged_date_startstring date-time

Flagged date start (ISO date)

flagged_date_endstring date-time

Flagged date end (ISO date)

expiration_date_startstring date-time

Expiration date start (ISO date)

expiration_date_endstring date-time

Expiration date end (ISO date)

Headers

organization-idstring

Response

List of provider flags based on advanced filter criteria

{"stackTrail":"paths:/v2/flags/search:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"flagId":"flag1","status":"unseen"}],"meta":{"total":1}}}

Example response

{
  "data": [
    {
      "flagId": "flag1",
      "status": "unseen"
    }
  ],
  "meta": {
    "total": 1
  }
}