Get Multi | Candid | API Reference

curl https://pre-api.joincandidhealth.com/organization-external-providers/v1 \
     -H "Authorization: Bearer <token>"

{
  "items": [
    {
      "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"
    }
  ],
  "total": 1,
  "next_page_token": "next_page_token",
  "prev_page_token": "prev_page_token"
}

Searches for organization external providers that match the query parameters.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

limitintegerOptional

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

sort_fieldstringOptional

Defaults to name.family.

sort_directionenumOptional

Defaults to ascending.

Allowed values:

npistringOptional

typeenumOptional

Allowed values:

first_namestringOptional

last_namestringOptional

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstring

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstring

A token that can be used to retrieve the next or previous page of results