# Trailflow Partner API

## Docs

- [Export analytics dataset rows as CSV](https://trailflow.ai/docs/api-reference/analytics/export-analytics-dataset-rows-as-csv.md): Retrieve the current page of dataset rows as CSV for flat-file BI ingestion flows.
- [List analytics dataset rows](https://trailflow.ai/docs/api-reference/analytics/list-analytics-dataset-rows.md): Retrieve cursor-paginated JSON rows for a dataset. Keep the base URL fixed and vary query parameters for BI refresh compatibility.
- [List analytics datasets](https://trailflow.ai/docs/api-reference/analytics/list-analytics-datasets.md): Discover reporting-ready datasets available for BI tools and warehouse sync consumers. Requires `analytics:read`.
- [Retrieve analytics dataset](https://trailflow.ai/docs/api-reference/analytics/retrieve-analytics-dataset.md): Retrieve schema metadata, sync hints, and format details for a single analytics dataset.
- [List carriers](https://trailflow.ai/docs/api-reference/carriers/list-carriers.md): Retrieve a list of carriers for the organization.
- [List customers](https://trailflow.ai/docs/api-reference/customers/list-customers.md): Retrieve a list of customers for the organization.
- [Create driver](https://trailflow.ai/docs/api-reference/drivers/create-driver.md): Create a new driver. Requires `drivers:write` scope.
- [Delete driver](https://trailflow.ai/docs/api-reference/drivers/delete-driver.md): Permanently delete a driver. This action cannot be undone.
- [List drivers](https://trailflow.ai/docs/api-reference/drivers/list-drivers.md): Retrieve a list of drivers for the organization.
- [Retrieve driver](https://trailflow.ai/docs/api-reference/drivers/retrieve-driver.md): Retrieve the full profile of a specific driver.
- [Update driver](https://trailflow.ai/docs/api-reference/drivers/update-driver.md): Partially update specific fields of an existing driver.
- [Health check](https://trailflow.ai/docs/api-reference/health/health-check.md): Lightweight health probe. No authentication required.
- [Create load](https://trailflow.ai/docs/api-reference/loads/create-load.md): Create a new load. Requires `loads:write` scope.
- [List loads](https://trailflow.ai/docs/api-reference/loads/list-loads.md): Retrieve a paginated list of loads. Use `nextCursor` from the response to fetch subsequent pages.
- [Retrieve load](https://trailflow.ai/docs/api-reference/loads/retrieve-load.md): Retrieve a single load by Convex ID or external ID.
- [Update load status](https://trailflow.ai/docs/api-reference/loads/update-load-status.md): Change the status of an existing load.
- [Upsert load](https://trailflow.ai/docs/api-reference/loads/upsert-load.md): Create or update a load by `externalId`. If a mapping exists, the load is updated; otherwise a new load is created.
- [Get load tracking](https://trailflow.ai/docs/api-reference/tracking/get-load-tracking.md): Retrieve tracking data for a load, including last known location and route information.
- [Create webhook](https://trailflow.ai/docs/api-reference/webhooks/create-webhook.md): Create a webhook subscription. Returns the subscription and a `signingSecret` for verifying payloads (HMAC SHA-256).
- [Delete webhook](https://trailflow.ai/docs/api-reference/webhooks/delete-webhook.md): Delete (deactivate) a webhook subscription.
- [List webhooks](https://trailflow.ai/docs/api-reference/webhooks/list-webhooks.md): List all active webhook subscriptions for the current API client.
- [Authentication And Requests](https://trailflow.ai/docs/guides/authentication-and-requests.md): Authentication, headers, idempotency, request tracing, and error handling for Partner API integrations.
- [Errors And Limits](https://trailflow.ai/docs/guides/errors-and-limits.md): Operational guidance for errors, rate limits, retries, and support workflows in the Partner API.
- [Examples And Payloads](https://trailflow.ai/docs/guides/examples-and-payloads.md): Representative request and response examples for common Partner API integration flows.
- [Load Sync](https://trailflow.ai/docs/guides/load-sync.md): Recommended polling, pagination, identifier, and tracking-eligibility behavior for load synchronization.
- [Webhooks](https://trailflow.ai/docs/guides/webhooks.md): Webhook subscription, delivery, retry, and signature verification guidance for Partner API partners.
- [Trailflow Partner API](https://trailflow.ai/docs/index.md): Partner-facing API docs for onboarding, test-mode setup, and canonical API reference.
- [Access And Environments](https://trailflow.ai/docs/introduction/access-and-environments.md): Partner-facing access model, testing expectations, and environment guidance for the Partner API.
- [API Overview](https://trailflow.ai/docs/introduction/api-overview.md): Platform framing, resource model, and integration journey for the Trailflow Partner API.
- [Overview](https://trailflow.ai/docs/introduction/overview.md): Canonical product and contract overview for the Trailflow Partner API.
- [Onboarding Package](https://trailflow.ai/docs/onboarding/package-and-environments.md): What Trailflow shares during partner onboarding and how test and live access work.
- [API Contract](https://trailflow.ai/docs/reference/api-contract.md): How to use the canonical OpenAPI contract and autogenerated API reference for the Partner API.
- [Changelog](https://trailflow.ai/docs/reference/changelog.md): Version and release notes for the Partner API contract and tooling.
- [SDK And Tooling](https://trailflow.ai/docs/reference/sdk-and-tooling.md): How Trailflow maintains the generated Partner API SDK and related tooling from the canonical contract.
- [Versioning And Compatibility](https://trailflow.ai/docs/reference/versioning-and-compatibility.md): Compatibility expectations, additive-first change rules, and partner upgrade posture for the Partner API.

## OpenAPI Specs

- [openapi.v1](https://trailflow.ai/docs/openapi.v1.yaml)
- [openapi](https://trailflow.ai/docs/api-reference/openapi.json)