Dentrix Ascend Fetch providers

POSThttps://preview.ontross.com/api/integrations/dentrix-ascend/fetch-providers

input.active_only

boolean

Return only active providers.

Example

true

Default

false

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

providers

array

Organization clinicians remaining after the requested activity filter.

providers[].id

string

Clinician identifier returned by the organization lookup.

Example

"64000000026082"

providers[].first_name

string

Clinician's given personal label from the organization record.

Example

"Avery"

providers[].last_name

string

Clinician's family surname from the organization record.

Example

"Morgan"

providers[].short_name

string

Abbreviated clinician display label from the organization record.

Example

"Dr. Capazzi"

providers[].title

string

Professional credential or designation from the clinician record.

Example

"DDS"

providers[].npi

string

National clinician registry identifier from the organization record.

Example

"1999999984"

providers[].active

boolean

Whether the organization marks this clinician as currently enabled.

Example

true

providers[].is_primary_provider

boolean

Whether the organization designates this clinician for primary care.

Example

true

count

integer

Total clinicians in the returned collection.

Example

4

curl --request POST \
  --url https://preview.ontross.com/api/integrations/dentrix-ascend/fetch-providers \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"active_only":true},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "active_only": true
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "providers": [
      {
        "id": "64000000026082",
        "first_name": "Avery",
        "last_name": "Morgan",
        "short_name": "Dr. Capazzi",
        "title": "DDS",
        "npi": "1999999984",
        "active": true,
        "is_primary_provider": true
      }
    ],
    "count": 4
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}