JOjoincandidhealth
v3

Get all organization providers

Changed on
get/api/organization-providers/v3

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/organization-providers/v3
  • Auth
    HTTP bearer

Query parameters

limitinteger

Limit the number of results returned. Defaults to 100.

search_termstring

Filter to a name or a part of a name.

npistring

Filter to a specific NPI.

is_renderingboolean

Filter to only rendering providers.

is_billingboolean

Filter to only billing providers.

organization_provider_idsstring uuid

Filter to the provided organization provider IDs.

page_tokenstring

The page token to continue paging through a previous request.

sort'provider_name:asc' | 'provider_name:desc' | 'npi:asc' | 'npi:desc'

Defaults to PROVIDER_NAME_ASC.

organization_idstring uuid

Filter to a specific organization's providers. If not provided, defaults to the requesting user's organization.

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 97de8fddb088Revision changes
    • warning

      added the new RT enum value to the // response property for the response status

  • 24b2d80d577aRevision changes
    • breaking

      the query request parameter sort was restricted to a list of enum values

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new enum value npi:asc to the query request parameter sort

    • info

      added the new enum value npi:desc to the query request parameter sort

    • info

      added the new enum value provider_name:asc to the query request parameter sort

    • info

      added the new enum value provider_name:desc to the query request parameter sort

    • info

      for the query request parameter organization_provider_ids, the type was generalized from no type to string, and format from no format to uuid

    • info

      for the query request parameter sort, the type was generalized from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status