Skip to content
CertifyOS API
/
/
Deactivate (clear) a flag

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

v2/provider-with-groups

Operations

flags

Operations

Get all provider flags

Request

Returns a list of all provider flags for the given organization. Supports filtering by NPI, read status, and shared status.

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
readboolean
sharedboolean
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/flags?offset=0&limit=10&npi=string&read=true&shared=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of all the provider flags for provider organization id

Bulk deactivate (clear) flags

Request

Deactivates (clears) multiple flags in bulk for the current user.

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired

Array of flag objects to deactivate.

flagsArray of objects(FlagPatchRequestDto)required
idstringrequired
activebooleanrequired
curl -i -X PATCH \
  https://docs.certifyos.com/_mock/reference/application/api/flags \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "flags": [
      {
        "id": "string",
        "active": true
      }
    ]
  }'

Responses

The flag has been successfully cleared.

Bodyapplication/json
flagsArray of objects(FlagPatchResponseDto)required
idstringrequired
successbooleanrequired
Response
application/json
{
  "flags": [
    { … }
  ]
}

Deactivate (clear) a flag

Request

Deactivates (clears) a specific flag by its ID.

Security
BearerAuth
Path
idstringrequired

The unique identifier of the flag to deactivate.

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

Responses

Activate (un-clear) a flag

Request

Activates (un-clears) a specific flag by its ID.

Security
BearerAuth
Path
idstringrequired

The unique identifier of the flag to activate.

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

Responses

Mark flag as read via webhook

Request

Marks a flag as read using a webhook event.

Security
BearerAuth
Path
idstringrequired

The unique identifier of the flag to mark as read.

Headers
organization-idstring
Bodyapplication/jsonrequired

Optional reason for marking as read.

object
curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/flags/webhook/{id}/mark-read' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "reason": "Reviewed via webhook"
  }'

Responses

Updated.

Bulk mark flags as read

Request

Marks multiple 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.

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

Responses

If all of the IDs marked as read successfully.

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

Mark a 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
Bodyapplication/jsonrequired

Reason for marking the flag as read.

object
curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/flags/{id}/mark-read' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "reason": "Flag reviewed by analyst"
  }'

Responses

Mark a flag as unread

Request

Marks a specific flag as unread for the current user.

Security
BearerAuth
Path
idstringrequired

The unique identifier of the flag to mark as unread.

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

Responses

Get Provider Flags

Request

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(s) (comma or dash separated)

flagTypeArray of strings

Type of flag

Example: flagType=flagType1,flagType2,flagType3
firstNamestring

First name

lastNamestring

Last name

subCollectionNameArray of strings

Sub collection name

Example: subCollectionName=subCollection1,subCollection2,subCollection3
sharedToCredCommitteeboolean

Shared to cred committee (boolean)

flagReadStatusstring(ReadStatus)

Flag read status (seen, unseen, all)

Enum"seen""unseen""all"
flaggedDateStartstring(date-time)

Flagged date start (ISO date)

flaggedDateEndstring(date-time)

Flagged date end (ISO date)

expirationDateStartstring(date-time)

Expiration date start (ISO date)

expirationDateEndstring(date-time)

Expiration date end (ISO date)

reportDateStartstring(date-time)

Report date start (ISO date)

reportDateEndstring(date-time)

Report date end (ISO date)

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/flags/search?offset=0&limit=10&npi=string&flagType=flagType1%2CflagType2%2CflagType3&firstName=string&lastName=string&subCollectionName=subCollection1%2CsubCollection2%2CsubCollection3&sharedToCredCommittee=true&flagReadStatus=seen&flaggedDateStart=2019-08-24T14%3A15%3A22Z&flaggedDateEnd=2019-08-24T14%3A15%3A22Z&expirationDateStart=2019-08-24T14%3A15%3A22Z&expirationDateEnd=2019-08-24T14%3A15%3A22Z&reportDateStart=2019-08-24T14%3A15%3A22Z&reportDateEnd=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
  }
}

Bulk mark flags as unread

Request

Marks multiple flags as unread 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 unread.

flagIdsArray of stringsrequired
curl -i -X PATCH \
  https://docs.certifyos.com/_mock/reference/application/api/flags/bulk-mark-unread \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "flagIds": [
      "string"
    ]
  }'

Responses

If all of the IDs marked as unread successfully.

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

Mark all flags as read for a provider and approve

Request

Marks all flags as read for a specific provider and marks the provider as approved.

Security
BearerAuth
Path
idstringrequired

The unique identifier of the provider.

Headers
organization-idstring
Bodyapplication/jsonrequired

Reason for marking all as read and approving.

object
curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/flags/{id}/mark-all-read-for-provider' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "reason": "Provider reviewed and approved"
  }'

Responses

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations