Skip to content
CertifyOS API
/
/
Find Flags For Provider

CertifyOS API

Download OpenAPI description
api.json
api.yaml
Overview
Languages
Servers
Mock server
https://docs.certifyos.com/_mock/reference/application/api/
Production
https://ng-api-production.certifyos.com/
Staging (Test Data)
https://ng-api-stg.certifyos.com/

auth-tokens

Operations

credentialing-workflows

Operations

v2/credentialing-workflows

Operations

providers

Operations

v2/provider

Operations

v2/providers

Operations

v2/flags

Operations

Find Flags For Provider

Request

Security
BearerAuth
Query
provider_idstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/flags?provider_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Successfully fetched flags.

Bodyapplication/jsonArray [
idstringrequired
readbooleanrequired
activebooleanrequired
subCollectionNamestringrequired
descriptionstringrequired
actionSourcestringrequired
createdAtstringrequired
flagTypestringrequired
]
Response
application/json
[
  {
    "id": "string",
    "read": true,
    "active": true,
    "subCollectionName": "string",
    "description": "string",
    "actionSource": "string",
    "createdAt": "string",
    "flagType": "string"
  }
]

Mark multiple flags as read

Request

Marks a list of flags as read for the current user. Returns 204 if all succeeded, 207 if some failed.

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired

Payload containing flag IDs to mark as read and a reason.

flag_idsArray of stringsrequired
reasonstringrequired
Example: "Reason while marking flag as read"
curl -i -X PATCH \
  https://docs.certifyos.com/_mock/reference/application/api/v2/flags/bulk-mark-read \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "flag_ids": [
      "string"
    ],
    "reason": "Reason while marking flag as read"
  }'

Responses

All flags marked as read successfully.

Bodyapplication/json
any
Response
application/json
{
  "success": true
}

Mark a single flag as read

Request

Marks a specific flag as read for the current user.

Security
BearerAuth
Path
idstringrequired

The unique identifier of the flag to mark as read.

Headers
organization-idstring
curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/flags/{id}/mark-read' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

The flag has been successfully marked read.

Search provider flags

Request

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.

Security
BearerAuth
Query
offsetnumber>= 0

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

Default 0
limitnumber

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

Default 10
npistring

Provider NPI

flag_typeArray of strings

Type of flag

Example: flag_type=flagType1,flagType2,flagType3
first_namestring

First name

last_namestring

Last name

sub_collection_nameArray of strings

Sub collection name

Example: sub_collection_name=subCollection1,subCollection2,subCollection3
shared_to_cred_committeeboolean

Shared to cred committee (boolean)

flagReadStatusstring(ReadStatus)

Flag read status (seen, unseen, all)

Enum"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
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/flags/search?offset=0&limit=10&npi=string&flag_type=flagType1%2CflagType2%2CflagType3&first_name=string&last_name=string&sub_collection_name=subCollection1%2CsubCollection2%2CsubCollection3&shared_to_cred_committee=true&flagReadStatus=seen&flagged_date_start=2019-08-24T14%3A15%3A22Z&flagged_date_end=2019-08-24T14%3A15%3A22Z&expiration_date_start=2019-08-24T14%3A15%3A22Z&expiration_date_end=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of provider flags based on advanced filter criteria

Bodyapplication/json
any
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "total": 1
  }
}

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations