{
  "opencollection": "1.0.0",
  "info": {
    "name": "Verifiable API Documentation Alerts CredentialingRequests API",
    "version": "26.12.1.962"
  },
  "items": [
    {
      "info": {
        "name": "CredentialingRequests",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Aggregate provider credentialing request owners\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://discovery.verifiable.com/api/credentialing-requests/aggregations/owners",
            "params": [
              {
                "name": "providerDeactivated",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered on requests for the providers with the specified deactivated status."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns an aggregation of all owners assigned to provider credentialing requests\n"
        },
        {
          "info": {
            "name": "List credentialing requests\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://discovery.verifiable.com/api/credentialing-requests",
            "params": [
              {
                "name": "entityType",
                "value": "",
                "type": "query",
                "description": "Indicates whether to retrieve credentialing requests for providers or facilities. Defaults to `Providers`."
              },
              {
                "name": "currentEventStatus",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified current event status."
              },
              {
                "name": "providerCredentialingStatus",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified provider credentialing status. Has no effect when querying facilities."
              },
              {
                "name": "priority",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified priority."
              },
              {
                "name": "ownerId",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified owner."
              },
              {
                "name": "includeUnassigned",
                "value": "",
                "type": "query",
                "description": "If set, the items will include credentialing requests that are not assigned to any specified owner. Intended to be used together with `ownerId`."
              },
              {
                "name": "credentialingRequestType",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified credentialing request type."
              },
              {
                "name": "entityId",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified entity identifier (`providerId` or `facilityId`)."
              },
              {
                "name": "entityName",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified entity name (provider name/alias or facility name)."
              },
              {
                "name": "entityNpi",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified entity NPI number."
              },
              {
                "name": "entityDeactivated",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified entity deactivated status."
              },
              {
                "name": "facilitySpecialtyId",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered by the specified specialty."
              },
              {
                "name": "providerId",
                "value": "",
                "type": "query",
                "description": "See `entityId`."
              },
              {
                "name": "providerName",
                "value": "",
                "type": "query",
                "description": "See `entityName`."
              },
              {
                "name": "providerNpi",
                "value": "",
                "type": "query",
                "description": "See `entityNpi`."
              },
              {
                "name": "providerDeactivated",
                "value": "",
                "type": "query",
                "description": "See `entityDeactivated`."
              },
              {
                "name": "sortedBy",
                "value": "",
                "type": "query",
                "description": "The property by which the returned data will be sorted."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "If set, the properties and directions the returned data will be sorted by."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset for the page to start."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "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."
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "The number of items to include in a single page."
              },
              {
                "name": "sortDirection",
                "value": "",
                "type": "query",
                "description": "The direction the returned data will be sorted by."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns credentialing requests\n"
        },
        {
          "info": {
            "name": "Create a new credentialing request\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://discovery.verifiable.com/api/credentialing-requests",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a new credentialing request for a provider or facility.\n"
        },
        {
          "info": {
            "name": "Create a new credentialing request event\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://discovery.verifiable.com/api/credentialing-requests/:requestId/events",
            "params": [
              {
                "name": "requestId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a new event for a credentialing request event.\n"
        },
        {
          "info": {
            "name": "Get a specific credentialing request\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://discovery.verifiable.com/api/credentialing-requests/:requestId",
            "params": [
              {
                "name": "requestId",
                "value": "",
                "type": "path",
                "description": "Identifier of the credentialing request to get the data for."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the data for a specific credentialing request.\n"
        },
        {
          "info": {
            "name": "Patch an existing credentialing request\n",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://discovery.verifiable.com/api/credentialing-requests/:requestId",
            "params": [
              {
                "name": "requestId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Changes properties for an existing credentialing request.\n"
        },
        {
          "info": {
            "name": "Get credentialing requests aggregations\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://discovery.verifiable.com/api/credentialing-requests/aggregations",
            "params": [
              {
                "name": "entityDeactivated",
                "value": "",
                "type": "query",
                "description": "If set, the items will be filtered based on the deactivated status of entities. If not specified, all entities are included regardless of deactivation status."
              },
              {
                "name": "entityType",
                "value": "",
                "type": "query",
                "description": "The entity type to be used for filtering items. Valid values are `Practitioner` or `Facility`. Default is `Practitioner`."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns aggregated counts for provider or facility credentialing requests.\n"
        },
        {
          "info": {
            "name": "Get a specific credentialing request event.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://discovery.verifiable.com/api/credentialing-requests/:requestId/events/:eventId",
            "params": [
              {
                "name": "requestId",
                "value": "",
                "type": "path",
                "description": "Identifier of the credentialing request to get the data for."
              },
              {
                "name": "eventId",
                "value": "",
                "type": "path",
                "description": "Identifier of the credentialing request event to get the data for."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the data for a specific credentialing request event.\n"
        },
        {
          "info": {
            "name": "Get the credentialing data for a facility\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://discovery.verifiable.com/api/facilities/:facilityId/credentialing-data",
            "params": [
              {
                "name": "facilityId",
                "value": "",
                "type": "path",
                "description": "Identifier of the facility to get the data for."
              },
              {
                "name": "credentialingRequestId",
                "value": "",
                "type": "query",
                "description": "Identifier of the credentialing request associated to the facility."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the credentialing data for a facility.\n"
        },
        {
          "info": {
            "name": "Get the credentialing data for a provider\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://discovery.verifiable.com/api/providers/:providerId/credentialing-data",
            "params": [
              {
                "name": "providerId",
                "value": "",
                "type": "path",
                "description": "Identifier of the provider to get the data for."
              },
              {
                "name": "credentialingRequestId",
                "value": "",
                "type": "query",
                "description": "Identifier of the credentialing request associated to the provider."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the credentialing data for a provider.\n"
        },
        {
          "info": {
            "name": "Create or replace a credentialing request checklist\n",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://discovery.verifiable.com/api/credentialing-requests/:requestId/checklist",
            "params": [
              {
                "name": "requestId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates or replaces a checklist for a credentialing request.\n"
        }
      ]
    }
  ],
  "bundled": true
}