Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Contracts

Fetch a single contract by its ID

Returns a single Contract identified by its server-assigned id.

When to use: Use this endpoint when you already hold a specific contract id (returned by a prior create, replace, or list call) and need the full record. To search or page through all contracts for a tenant, use GET /contracts instead.

Preconditions: Requires the READ_CONTRACT permission. The tenant-id header must identify the tenant the contract belongs to. The {id} path parameter is the server-assigned id field (a distinct value from documentId, which is a caller-supplied identifier).

Response: Returns the full Contract object, including its generalInfo, lifecycle, financial, administrativeAndLegal, and clinicalAndQuality sections. This operation is safe and idempotent; it makes no changes.

get/contracts/{id}

Path parameters

idstring required

Server-assigned id of the Contract to fetch (not the documentId).

Headers

tenant-idstring required

Tenant ID used to scope the lookup to the caller's tenant.

Response

The Contract identified by id, with all composite sections populated as stored.

idstring

Server-assigned unique identifier (UUID). Ignored if supplied in a create request; on replace (PUT), the existing contract's id is always preserved regardless of what is sent.

planIdstring

Identifier of the plan this contract belongs to. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's planId is always preserved.

networkIdstring

Identifier of the network this contract belongs to. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's networkId is always preserved.

documentIdstring

Caller-supplied business document identifier for this contract. Required on create. On replace (PUT), any value supplied here is ignored - the existing contract's documentId is always preserved.

createdBystring

User ID of the caller who originally created the contract. Always set by the server from the authenticated caller on create; any value supplied in the request body is ignored. Preserved unchanged on every subsequent replace (PUT), regardless of the request body.

updatedBystring

User ID of the caller who most recently created or replaced the contract. Always set by the server from the authenticated caller; any value supplied in the request body is ignored.

Example response

{
  "id": "ctr_8a2f3e91",
  "planId": "plan_40921",
  "networkId": "network_58213",
  "documentId": "doc_2026_04821",
  "createdBy": "user_30172",
  "updatedBy": "user_58890",
  "generalInfo": {
    "contractId": "GC-2026-0417",
    "contractName": "Acme Health Network FFS Agreement",
    "contractTemplate": "Standard FFS Template v3",
    "contractRate": "100% Medicare",
    "reimbursementCode": "RC-1042",
    "contractType": "FFS",
    "contractStatus": "Active",
    "contractAgreementType": "Single",
    "groupId": "group_12345",
    "networkId": "network_58213",
    "planId": "plan_40921"
  },
  "lifecycle": {
    "contractEffectiveDate": "2026-01-01",
    "initialTermDate": "2027-01-01",
    "terminationInformedDate": "2026-11-01",
    "terminationDate": "2026-12-31",
    "billingEffectiveDate": "2026-01-01",
    "billingTerminationDate": "2026-12-31"
  },
  "financial": {
    "feeSchedule": "Medicare FFS 2026",
    "contractPaymentType": "Per Claim",
    "providerRateCalculation": "Standard Medicare fee schedule",
    "claimSubmissionCycle": "Monthly"
  },
  "administrativeAndLegal": {
    "practitionersTerminationNoticePeriod": "90",
    "providersManualUpdatesNoticePeriod": "60",
    "claimFilingLimit": "180 days from date of service",
    "reimbursementScheduleUpdateFrequency": "Quarterly",
    "timelyPaymentCommitment": 30
  },
  "clinicalAndQuality": {
    "averageStarsAndPmpmBonus": "4.5 stars / $10 PMPM",
    "performanceReportingRequirements": "Quarterly HEDIS and CAHPS reporting",
    "recredentialingInterval": "3 yr",
    "providerRosterUpdateFrequency": "Monthly"
  }
}