Candid Health

Candid Health Exports API

The Exports API from Candid Health — 1 operation(s) for exports.

Documentation GitHub OpenAPI

Operations 1

GET /api/exports/v3 Get exports #

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/candid-health:candid-health-exports-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Reference Exports API
  version: 1.0.0
servers:
- url: https://pre-api.joincandidhealth.com
  description: Production
- url: https://pre-api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-pre-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-pre-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:4000
  description: Local
- url: https://api.joincandidhealth.com
  description: Production
- url: https://api-staging.joincandidhealth.com
  description: Staging
- url: https://sandbox-api.joincandidhealth.com
  description: CandidSandbox
- url: https://staging-api.joincandidhealth.com
  description: CandidStaging
- url: http://localhost:5050
  description: Local
tags:
- name: Exports
paths:
  /api/exports/v3:
    get:
      operationId: get_exports
      summary: Get exports
      description: 'API-based exports are in the process of being deprecated in favor of Candid Data Share and are not being offered to new customers.

        Please see the Candid Data Share docs for more information.


        Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint returns Export objects that contain an

        authenticated URL to a customer''s reports with a 2min TTL. The schema for the CSV export can be found here.


        **Schema changes:** Changing column order, removing columns, or changing the name of a column is considered a

        Breaking Change. Adding new columns to the end of the Exports file is not considered a

        Breaking Change and happens periodically. For this reason, it is important that any downstream automation or processes built on top

        of Candid Health''s export files be resilient to the addition of new columns at the end of the file.


        **SLA guarantees:** Files for a given date are guaranteed to be available after 3 business days. For example, Friday''s file will be

        available by Wednesday at the latest. If file generation is still in progress upon request before 3 business days have passed, the

        caller will receive a 422 response. If the file has already been generated, it will be served. Historic files should be available

        up to 90 days in the past by default. Please email our Support team with any data requests

        outside of these stated guarantees.'
      tags:
      - Exports
      parameters:
      - name: start_date
        in: query
        description: 'Beginning date of claim versions returned in the export, ISO 8601 date e.g. 2019-08-24.

          Must be at least 1 calendar day in the past. Cannot be earlier than 2022-10-07.'
        required: true
        schema:
          type: string
          format: date
      - name: end_date
        in: query
        description: 'Ending date of claim versions returned in the export, ISO 8601 date; e.g. 2019-08-24.

          Must be within 30 days of start_date.'
        required: true
        schema:
          type: string
          format: date
      - name: Authorization
        in: header
        description: OAuth authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_exports_v3_GetExportsResponse'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - ExportDisabledError
                  content:
                    $ref: '#/components/schemas/type_commons_ErrorMessage'
                required:
                - errorName
                - content
        '422':
          description: Error response with status 422
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - UnsupportedExportWindowError
                  content:
                    $ref: '#/components/schemas/type_commons_ErrorMessage'
                required:
                - errorName
                - content
        '503':
          description: Error response with status 503
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - MissingDailyIncrementalExportFileError
                  content:
                    $ref: '#/components/schemas/type_commons_ErrorMessage'
                required:
                - errorName
                - content
components:
  schemas:
    type_commons_ErrorMessage:
      type: string
      title: ErrorMessage
    type_exports_v3_GetExportsResponse:
      type: object
      properties:
        name:
          type: string
          description: Report name; contains date strings representing the start and end date of the export.
        created_at:
          type: string
          format: date-time
        authenticated_download_url:
          type: string
          description: Authenticated URL where a customer's report can be retrieved.
        authenticated_download_url_expiration:
          type: string
          format: date-time
          description: Expiration datetime of the authenticated URL. URLs expire after 2 minutes.
      required:
      - name
      - created_at
      - authenticated_download_url
      - authenticated_download_url_expiration
      title: GetExportsResponse
  securitySchemes:
    OAuthScheme:
      type: http
      scheme: bearer
      description: OAuth 2.0 authentication
x-provenance:
  method: harvested
  publisher: Candid Health
  source: https://docs.joincandidhealth.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)