Get contract

Beta
GET
/api/contracts/v2/:contract_id

Path parameters

contract_idUUIDRequired

Response

This endpoint returns an object.
commercial_insurance_typesobject

The commercial plan insurance types this contract applies.

contract_idUUID
contracting_providerobject

The provider under contract

effective_datestring

The starting day upon which the contract is effective

medicaid_insurance_typesobject

The Medicaid plan insurance types this contract applies.

medicare_insurance_typesobject

The Medicare plan insurance types this contract applies.

payerobject

The insurance company under contract

provider_countinteger

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

regionsobject

The state(s) to which the contract’s coverage extends. It may also be set to “national” for the entirety of the US.

rendering_provider_idsset of UUIDs

The providers who can render medical services under the contract

authorized_signatoryobjectOptional
contract_statusenumOptional
Allowed values: pendingeffectivecancelled
expiration_datestringOptional

An optional end day upon which the contract expires

Errors

Built with