JOjoincandidhealth
v1

Get Multi

Changed on

Searches for organization external providers that match the query parameters.

get/organization-external-providers/v1

Request

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

Query parameters

limitinteger
page_tokenstring

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

sort_fieldstring

The field to order by. Valid values are keys on the provider object (e.g., name.family, npi, updatedAt, createdAt) or a special ordering "similar_name:<search_string>" (Ex: similar_name:John). Similar name ordering uses trigrams to fuzzy match provider name to the search criteria.

Defaults to name.family.

sort_direction'asc' | 'desc'

Defaults to ascending.

npistring
type'REFERRING' | 'PRIMARY' | 'TREATING'
first_namestring
last_namestring

Response

Response with status 200

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

totalinteger required

Changes

  • 72fc5ca65ba5Revision changes
    • info

      added the optional property //// to the response with the status

  • 24b2d80d577aRevision changes
    • breaking

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

    • breaking

      the query request parameter type 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 PRIMARY to the query request parameter type

    • info

      added the new enum value REFERRING to the query request parameter type

    • info

      added the new enum value TREATING to the query request parameter type

    • info

      added the new enum value asc to the query request parameter sort_direction

    • info

      added the new enum value desc to the query request parameter sort_direction

    • info

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

    • info

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

    • info

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

    • info

      for the query request parameter type, 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

    • info

      added the required property to the response with the status