Backwork
API Reference

List decisions from a certified release

Returns only the immutable derived_decision_v1 allowlist from one certified_release.v1 snapshot. This surface requires a dedicated API key whose complete scope set is exactly certified:derived_decision:read; OAuth credentials, ordinary read or admin keys, and keys carrying any additional scope are not valid for this endpoint. The key must also hold an active entitlement to the requested release. Responses are JSON only: omit format and _format, and omit Accept or request application/json (a wildcard Accept header is also treated as JSON). CSV or FHIR negotiation returns 406. Missing, expired, revoked, schema-incompatible, and unentitled releases intentionally share the same non-enumerating 404 response. An authorized query with no matching decision returns 200 with an empty data array.

GET
/releases/{releaseId}/decisions

Authorization

bearerAuth
AuthorizationBearer <token>

API keys are prefixed with bwk_live_ for production or bwk_test_ for testing. Example: bwk_live_abc123xyz

Keys issued before the current format carry the vrt_live_/vrt_test_ prefix. Both prefixes are accepted while integrations rotate.

In: header

Path Parameters

releaseId*string

Content-addressed certified release ID assigned to the dedicated key

Match^bwr_[0-9a-f]{64}$

Query Parameters

code*string

CPT, HCPCS, ICD-10-CM, or ICD-10-PCS code. Input is normalized to uppercase.

Match^[A-Za-z0-9.]+$
Length1 <= length <= 20
code_system?string

Optional code-system filter

Value in"CPT" | "HCPCS" | "ICD10CM" | "ICD10PCS"
payer_code?string

Optional canonical payer-code filter. Input is normalized to uppercase.

Match^[A-Za-z0-9_.-]+$
Length1 <= length <= 100
cursor?string

Decision ID returned as the prior page's pagination cursor

Match^bwd_[0-9a-f]{64}$
limit?integer

Results per page

Default50
Range1 <= value <= 100

Header Parameters

Accept?string

Omit this header or request application/json. */* also resolves to JSON. Requests negotiating text/csv or application/fhir+json receive 406.

Default"application/json"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backworkhealth.com/api/v1/releases/string/decisions?code=string"
{
  "success": true,
  "data": [
    {
      "decision_id": "string",
      "record_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
      "policy_id": "string",
      "policy_version": 1,
      "policy_fingerprint_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
      "source_document_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
      "payer_code": "string",
      "line_of_business": "commercial",
      "code_system": "CPT",
      "code": "string",
      "disposition": "covered",
      "effective_date": "2019-08-24",
      "retire_date": "2019-08-24"
    }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "pagination": {
      "cursor": "string",
      "has_more": true,
      "limit": 1
    },
    "release_id": "string",
    "release_manifest_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
    "dataset_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
    "source_set_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
    "qa_certification_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
    "rights_evidence_sha256": "stringstringstringstringstringstringstringstringstringstringstri",
    "qa_status": "certified",
    "rights_status": "approved",
    "field_profile": "derived_decision_v1",
    "release_schema_version": "certified_release.v1",
    "source_as_of": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "certified_at": "2019-08-24T14:15:22Z",
    "rights_approved_at": "2019-08-24T14:15:22Z",
    "release_created_at": "2019-08-24T14:15:22Z"
  }
}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid query parameters",
    "hint": "Check the 'code' parameter format",
    "details": {}
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid query parameters",
    "hint": "Check the 'code' parameter format",
    "details": {}
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid query parameters",
    "hint": "Check the 'code' parameter format",
    "details": {}
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid query parameters",
    "hint": "Check the 'code' parameter format",
    "details": {}
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
{
  "success": false,
  "error": {
    "code": "RESOURCE_RELEASE_NOT_AVAILABLE",
    "message": "Certified release is not available",
    "hint": "Use the release ID assigned to this dedicated certified-data key"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-08-23T12:00:00Z"
  }
}
{
  "success": false,
  "error": {
    "code": "REQUEST_FORMAT_NOT_ACCEPTABLE",
    "message": "Requested response format is not available",
    "hint": "Certified release endpoints support JSON only"
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-08-23T12:00:00Z"
  }
}
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid query parameters",
    "hint": "Check the 'code' parameter format",
    "details": {}
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

Last updated on