{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_pre-encounter.subpackage_pre-encounter/organizationExternalProviders.subpackage_pre-encounter/organizationExternalProviders/v1 API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_pre-encounter.subpackage_pre-encounter/organizationExternalProviders.subpackage_pre-encounter/organizationExternalProviders/v1",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/organization-external-providers/v1/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Gets an organization external provider by ID."
        },
        {
          "info": {
            "name": "Get Multi",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/organization-external-providers/v1",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "page_token",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_field",
                "value": "",
                "type": "query",
                "description": "Defaults to name.family."
              },
              {
                "name": "sort_direction",
                "value": "",
                "type": "query",
                "description": "Defaults to ascending."
              },
              {
                "name": "npi",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query"
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query"
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Searches for organization external providers that match the query parameters."
        },
        {
          "info": {
            "name": "Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pre-api.joincandidhealth.com/organization-external-providers/v1",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new organization external provider. BadRequestError is returned when the NPI is already in use."
        },
        {
          "info": {
            "name": "Update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pre-api.joincandidhealth.com/organization-external-providers/v1/:id/:version",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an organization external provider. The path must contain the next version number to prevent race conditions. For example, if the current version of the provider is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the provider. Updating historic versions is not supported. BadRequestError is returned when the NPI is already in use by another provider."
        },
        {
          "info": {
            "name": "Deactivate",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://pre-api.joincandidhealth.com/organization-external-providers/v1/:id/:version",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "version",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Sets an organization external provider as deactivated. The path must contain the most recent version plus 1 to prevent race conditions. Deactivating historic versions is not supported."
        },
        {
          "info": {
            "name": "Scan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pre-api.joincandidhealth.com/organization-external-providers/v1/updates/scan",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "since",
                "value": "",
                "type": "query"
              },
              {
                "name": "maxResults",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Scans up to 1000 organization external provider updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.\n\n**Polling Pattern:**\nTo continuously poll for updates without gaps:\n1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`)\n2. The API returns 100 by default and up to 1000 records, sorted by `updated_at` ascending\n3. Find the `updated_at` value from the last record in the response\n4. Use that `updated_at` "
        }
      ]
    }
  ],
  "bundled": true
}