BulkResponseBody

HealthcareMedicareMedicaidFHIRBulk DataOpen DataGovernmentFederalClaimsInsuranceACAMarketplaceQualityHealth InsuranceFederal GovernmentDrug SpendingProvider DataQuality MeasuresClaims DataGovernment Data

Properties

Name Type Description
JobID integer
error array Information about error files, including URLs for downloading
output array Information about generated data files, including URLs for downloading
request string URL of the bulk data export request
requiresAccessToken boolean Indicates whether an access token is required to download generated data files
transactionTime string Server time when the query was run
View JSON Schema on GitHub

JSON Schema

cms-gov-bulk-response-body-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cms-gov/json-schema/cms-gov-bulk-response-body-schema.json",
  "title": "BulkResponseBody",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cms-gov-job-api-openapi.yml#/components/schemas/BulkResponseBody",
  "type": "object",
  "properties": {
    "JobID": {
      "type": "integer",
      "format": "uint64"
    },
    "error": {
      "description": "Information about error files, including URLs for downloading",
      "type": "array",
      "items": {
        "$ref": "#/$defs/fileItem"
      },
      "x-go-name": "Errors"
    },
    "output": {
      "description": "Information about generated data files, including URLs for downloading",
      "type": "array",
      "items": {
        "$ref": "#/$defs/fileItem"
      },
      "x-go-name": "Files"
    },
    "request": {
      "description": "URL of the bulk data export request",
      "type": "string",
      "x-go-name": "RequestURL"
    },
    "requiresAccessToken": {
      "description": "Indicates whether an access token is required to download generated data files",
      "type": "boolean",
      "x-go-name": "RequiresAccessToken"
    },
    "transactionTime": {
      "description": "Server time when the query was run",
      "type": "string",
      "format": "date-time",
      "x-go-name": "TransactionTime"
    }
  },
  "x-go-package": "github.com/CMSgov/bcda-app/bcda/api",
  "$defs": {
    "fileItem": {
      "type": "object",
      "properties": {
        "type": {
          "description": "FHIR resource type of file contents",
          "type": "string",
          "x-go-name": "Type"
        },
        "url": {
          "description": "URL of the file",
          "type": "string",
          "x-go-name": "URL"
        }
      },
      "x-go-name": "FileItem",
      "x-go-package": "github.com/CMSgov/bcda-app/bcda/api"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cms-gov-bulk-response-body"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.