JOjoincandidhealth
v2

Get contract

Changed on

This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.

get/api/contracts/v2/{contract_id}

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/contracts/v2/{contract_id}
  • Auth
    HTTP bearer

Path parameters

contract_idstring uuid required

Query parameters

organization_idstring uuid

Organization context for cross-org access. If not provided, defaults to the requesting user's organization.

Response

Response with status 200

effective_datestring required

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

expiration_datestring

ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)

contract_status'pending' | 'effective' | 'cancelled'
contract_idstring uuid required
provider_countinteger required

The number of linked providers who can render medical services under this contract

rendering_provider_idsstring[] required

The providers who can render medical services under the contract

Changes

  • 97de8fddb088Revision changes
    • warning

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

  • 24b2d80d577aRevision changes
    • 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

      for the path request parameter contract_id, the type was generalized from no type to string, and format from no format to uuid

    • 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 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

    • info

      added the required 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

    • info

      added the required 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status