Scan | Candid | API Reference

curl -G https://pre-api.joincandidhealth.com/organization-external-providers/v1/updates/scan \
     -H "Authorization: Bearer <token>" \
     --data-urlencode since=2024-01-15T09:30:00Z

[
  {
    "deactivated": true,
    "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "name": {
      "family": "family",
      "given": [
        "given",
        "given"
      ],
      "use": "USUAL",
      "period": {
        "start": "2023-01-15",
        "end": "2023-01-15"
      },
      "suffix": "suffix"
    },
    "organization_id": "organization_id",
    "types": [
      "REFERRING",
      "REFERRING"
    ],
    "updated_at": "2024-01-15T09:30:00Z",
    "updating_user_id": "updating_user_id",
    "version": 1,
    "addresses": [
      {
        "use": "HOME",
        "line": [
          "line",
          "line"
        ],
        "city": "city",
        "state": "state",
        "postal_code": "postal_code",
        "country": "country",
        "period": {
          "start": "2023-01-15",
          "end": "2023-01-15"
        }
      },
      {
        "use": "HOME",
        "line": [
          "line",
          "line"
        ],
        "city": "city",
        "state": "state",
        "postal_code": "postal_code",
        "country": "country",
        "period": {
          "start": "2023-01-15",
          "end": "2023-01-15"
        }
      }
    ],
    "fax_number": "fax_number",
    "license_type": "MD",
    "npi": "npi",
    "phone_number": "phone_number",
    "tax_id": "tax_id",
    "taxonomy_code": "taxonomy_code"
  },
  {
    "deactivated": true,
    "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "name": {
      "family": "family",
      "given": [
        "given",
        "given"
      ],
      "use": "USUAL",
      "period": {
        "start": "2023-01-15",
        "end": "2023-01-15"
      },
      "suffix": "suffix"
    },
    "organization_id": "organization_id",
    "types": [
      "REFERRING",
      "REFERRING"
    ],
    "updated_at": "2024-01-15T09:30:00Z",
    "updating_user_id": "updating_user_id",
    "version": 1,
    "addresses": [
      {
        "use": "HOME",
        "line": [
          "line",
          "line"
        ],
        "city": "city",
        "state": "state",
        "postal_code": "postal_code",
        "country": "country",
        "period": {
          "start": "2023-01-15",
          "end": "2023-01-15"
        }
      },
      {
        "use": "HOME",
        "line": [
          "line",
          "line"
        ],
        "city": "city",
        "state": "state",
        "postal_code": "postal_code",
        "country": "country",
        "period": {
          "start": "2023-01-15",
          "end": "2023-01-15"
        }
      }
    ],
    "fax_number": "fax_number",
    "license_type": "MD",
    "npi": "npi",
    "phone_number": "phone_number",
    "tax_id": "tax_id",
    "taxonomy_code": "taxonomy_code"
  }
]

Scans up to 1000 organization external provider updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.

Polling Pattern: To continuously poll for updates without gaps:

Make your initial request with a since timestamp (e.g., since=2020-01-01T13:00:00.000Z)
The API returns 100 by default and up to 1000 records, sorted by updated_at ascending
Find the updated_at value from the last record in the response
Use that updated_at value as the since parameter in your next request
Repeat steps 2-4 to ingest updates until you receive an empty list

Important Notes:

The since parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version)
All records include updated_at, id, version, deactivated, and updating_user fields for tracking changes
Timestamps have millisecond resolution for precise ordering

Scans up to 1000 organization external provider updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns 100 by default and up to 1000 records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

sincedatetimeRequired

maxResultsintegerOptional

Response

This endpoint returns a list of objects.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

idUUID

The unique identifier for an OrganizationExternalProvider in the database

nameobject

organization_idstring

The organization that owns this object.

typeslist of enums

Allowed values:

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

addresseslist of objects

fax_numberstring

license_typeenum

npistring

phone_numberstring

tax_idstring

taxonomy_codestring