{
  "opencollection": "1.0.0",
  "info": {
    "name": "CertifyOS Credentialing Workflows API"
  },
  "items": [
    {
      "info": {
        "name": "credentialing-workflows",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List of credentialing workflows",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ng-api-production.certifyos.com/credentialing-workflows",
            "headers": [
              {
                "name": "organization-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The starting index for pagination, specifying how many records to skip."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to retrieve in a single request."
              },
              {
                "name": "providerNpi",
                "value": "",
                "type": "query",
                "description": "Filter by provider NPI."
              },
              {
                "name": "providerFirstName",
                "value": "",
                "type": "query",
                "description": "Filter by provider first name."
              },
              {
                "name": "providerLastName",
                "value": "",
                "type": "query",
                "description": "Filter by provider last name."
              },
              {
                "name": "providerType",
                "value": "",
                "type": "query",
                "description": "Filter by provider type."
              },
              {
                "name": "providerFileType",
                "value": "",
                "type": "query",
                "description": "Filter by provider file type."
              },
              {
                "name": "providerState",
                "value": "",
                "type": "query",
                "description": "Filter by a single provider state."
              },
              {
                "name": "providerStates",
                "value": "",
                "type": "query",
                "description": "Filter by multiple provider states."
              },
              {
                "name": "providerAssignedStates",
                "value": "",
                "type": "query",
                "description": "Filter by provider assigned states."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter by workflow or provider name."
              },
              {
                "name": "onStep",
                "value": "",
                "type": "query",
                "description": "Filter by current workflow step (e.g. PSV_READY, IN_PROGRESS)."
              },
              {
                "name": "outreachReasons",
                "value": "",
                "type": "query",
                "description": "Filter by outreach reasons."
              },
              {
                "name": "createdAtStart",
                "value": "",
                "type": "query",
                "description": "Filter workflows created on or after this date (ISO 8601)."
              },
              {
                "name": "createdAtEnd",
                "value": "",
                "type": "query",
                "description": "Filter workflows created on or before this date (ISO 8601)."
              },
              {
                "name": "nextCredentialingStart",
                "value": "",
                "type": "query",
                "description": "Filter by next credentialing start date (on or after)."
              },
              {
                "name": "nextCredentialingEnd",
                "value": "",
                "type": "query",
                "description": "Filter by next credentialing end date (on or before)."
              },
              {
                "name": "credentialingCycle",
                "value": "",
                "type": "query",
                "description": "Filter by credentialing cycle."
              },
              {
                "name": "completedAtStart",
                "value": "",
                "type": "query",
                "description": "Filter workflows completed on or after this date."
              },
              {
                "name": "completedAtEnd",
                "value": "",
                "type": "query",
                "description": "Filter workflows completed on or before this date."
              },
              {
                "name": "credentialingStatusUpdatedAtStart",
                "value": "",
                "type": "query",
                "description": "Filter by credentialing status updated at (start of range)."
              },
              {
                "name": "credentialingStatusUpdatedAtEnd",
                "value": "",
                "type": "query",
                "description": "Filter by credentialing status updated at (end of range)."
              },
              {
                "name": "psvCompleteDateStart",
                "value": "",
                "type": "query",
                "description": "Filter by PSV complete date (start of range)."
              },
              {
                "name": "workflowIds",
                "value": "",
                "type": "query",
                "description": "Filter by specific workflow IDs."
              },
              {
                "name": "assignedTo",
                "value": "",
                "type": "query",
                "description": "Filter by user ID the workflow is assigned to."
              },
              {
                "name": "includeTerminatedProviders",
                "value": "",
                "type": "query",
                "description": "Include workflows for terminated providers."
              },
              {
                "name": "providerExternalId",
                "value": "",
                "type": "query",
                "description": "Filter by provider external ID."
              },
              {
                "name": "locationType",
                "value": "",
                "type": "query",
                "description": "Filter by organization entity location type."
              },
              {
                "name": "orgEntityIds",
                "value": "",
                "type": "query",
                "description": "Filter by organization entity IDs."
              },
              {
                "name": "providerOrgEntityIds",
                "value": "",
                "type": "query",
                "description": "Filter by provider organization entity IDs."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns a paginated list of credentialing workflows for the organization."
        },
        {
          "info": {
            "name": "CredentialingWorkflowsController_revertStatus",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://ng-api-production.certifyos.com/credentialing-workflows/:id/revert-status",
            "headers": [
              {
                "name": "organization-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          }
        },
        {
          "info": {
            "name": "Create Credentialing Note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://ng-api-production.certifyos.com/credentialing-workflows/:id/notes",
            "headers": [
              {
                "name": "organization-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "\n      Creates a new note associated with the specified credentialing workflow.\n\n      ### Functionality\n      - Adds a user-generated note to a credentialing workflow.\n      - Useful for internal communication, tracking decisions, or annotating the process.\n      - The note will be associated with the given workflow ID.\n"
        },
        {
          "info": {
            "name": "Update Credentialing Note",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://ng-api-production.certifyos.com/credentialing-workflows/:id/notes/:noteId",
            "headers": [
              {
                "name": "organization-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "noteId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "\nUpdates an existing note associated with a credentialing workflow.\n"
        },
        {
          "info": {
            "name": "Populate template fields for credentialing workflow",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ng-api-production.certifyos.com/credentialing-workflows/:id/populate-template-fields",
            "headers": [
              {
                "name": "organization-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the credentialing workflow for which to populate template fields."
              },
              {
                "name": "reasons",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of reasons to be included in the template fields (e.g., \"reason1,reason2\"). These reasons should already be present in the organization settings under \"outreach\" to be used here."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves and populates template fields for the specified credentialing workflow. Useful for generating documents, emails, or other communications that require workflow-specific data to be inserted into templates."
        }
      ]
    }
  ],
  "bundled": true
}