Get exports | Candid | API Reference

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.

<Warning> 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](https://docs.joincandidhealth.com/introduction/candid-data-share) for more information. </Warning> 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](https://app.joincandidhealth.com/files/exports_schema.csv). **Schema changes:** Changing column order, removing columns, or changing the name of a column is considered a [Breaking Change](../../../api-principles/breaking-changes). 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](mailto:support@joincandidhealth.com) with any data requests outside of these stated guarantees.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

start_datedateRequired

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.

end_datedateRequired

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.

Response

This endpoint returns an object.

namestring

Report name; contains date strings representing the start and end date of the export.

created_atdatetime

authenticated_download_urlstring

Authenticated URL where a customer's report can be retrieved.

authenticated_download_url_expirationdatetime

Expiration datetime of the authenticated URL. URLs expire after 2 minutes.

Errors

403

Export Disabled Error

422

Export Date Too Early Error

422

Export Not yet Available Error

422

HTTP Request Validations Error

422

Unsupported Export Window Error

503

Export Files Unavailable Error

503

Missing Daily Incremental Export File Error

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.

1	curl -G https://api.joincandidhealth.com/api/exports/v3 \
2	-H "Authorization: Bearer <token>" \
3	-d start_date=2023-10-01 \
4	-d end_date=2023-10-02

1	{
2	"name": "John Doe",
3	"created_at": "2021-10-07T00:00:00Z",
4	"authenticated_download_url": "https://example.com",
5	"authenticated_download_url_expiration": "2021-10-07T00:02:00Z"
6	}