JOjoincandidhealth
v3

Get all contracts

Changed on
get/api/contracts/v3

Request

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

Query parameters

page_tokenstring
limitinteger

Max number of contracts returned. Defaults to 1000. Max is 1000.

type'professional' | 'institutional'

The type of contract

contracting_provider_idstring uuid
rendering_provider_idsstring uuid
payer_namesstring

Filter to contracts that include any of the included payer names.

states'AA' | 'AE' | 'AP' | 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'FM' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MH' | 'MI' | 'MN' | 'MP' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'PW' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VI' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'FC'
contract_status'pending' | 'effective' | 'cancelled'

The status of the contract. Defaults to pending

sort'created_at' | 'payer_name' | 'payer_id' | 'billing_provider_name' | 'effective_date' | 'contract_status'

Potentially sort by a contract related attribute. Defaults to created_at

sort_direction'asc' | 'desc'

Direction of sort, defaulting to desc

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 97de8fddb088Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the / response property oneOf list for the response status

  • 24b2d80d577aRevision changes
    • breaking

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

    • breaking

      the query request parameter sort 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 billing_provider_name to the query request parameter sort

    • info

      added the new enum value cancelled to the query request parameter contract_status

    • info

      added the new enum value contract_status to the query request parameter sort

    • info

      added the new enum value created_at to the query request parameter sort

    • info

      added the new enum value effective to the query request parameter contract_status

    • info

      added the new enum value effective_date to the query request parameter sort

    • info

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

    • info

      added the new enum value payer_id to the query request parameter sort

    • info

      added the new enum value payer_name to the query request parameter sort

    • info

      added the new enum value pending to the query request parameter contract_status

    • info

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

    • info

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

    • info

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

    • info

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

      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