API

Everything you can do in the Trialflare web app is done through the Trialflare API, and that same API is open to you. Use it to pull study data into your own systems on a schedule, register participants from another platform, push responses collected elsewhere into a casebook, or automate the parts of study administration you find yourself repeating.

The API is a plain HTTPS/JSON interface at https://api.trialflare.com. You call it with an API key generated from your own account, and every request is subject to exactly the permissions you hold in the web app — a key cannot see or do anything you could not see or do yourself.

Getting started

  • Generating an API key — creating, naming, expiring and revoking keys from your account settings.
  • Authenticating requests — the base address, headers, identifiers, dates, errors, rate limits, exports and background jobs. Read this first.

Reference

Each article lists the endpoints for one area of the platform, with the fields each accepts.

  • Teams — your team, its users and its event log.
  • Users — your own account, other users' details, permissions and roles.
  • Trials — creating and configuring trials, personnel, roles, locking, logs, configuration versions and the schedule.
  • Sites — sites, site membership, monitoring visits, monitoring issues and site message boards.
  • Groups — participant groups and group membership.
  • Data types — the fields your forms are built from, and their tags.
  • Stages — forms and timepoints, stage groups and anchors.
  • Participant management — registering, listing, updating and withdrawing participants; messages, notifications, notes, events, meetings, packs, incentives and food diaries.
  • Responses and exports — entering and reading study data, validations, signatures and the export formats.
  • Queries — data queries, their comments, and automatic queries.
  • Automatic messages — scheduled and event-driven messages to participants.
  • eConsent — consent forms and consent records.
  • Files and documents — the eTMF: uploading, versioning and approving files.
  • Tasks — the task board and its lanes.
  • Packs — pack types and the packs dispensed to participants.
  • Dashboards and insights — dashboards, trial insights and participant insights.
  • Participant app — the endpoints the participant app itself uses, for building your own participant-facing experience.

Building with an AI assistant

If you are working with Claude, ChatGPT, Copilot or a coding agent, point it at:

https://help.trialflare.com/api/llms-full.txt

That is every page of this section — plus the definitions of the terms they use — as a single plain-text file, so an assistant can read the whole API in one request rather than crawling twenty pages. It is regenerated whenever these articles change, so it never falls behind what you are reading here.

This is for assistants writing code against the API. Connecting an assistant to your Trialflare data so it can answer questions about your trials is a different feature: see Connecting an AI assistant.

What is not documented here

The API also has endpoints that exist only to serve the Trialflare web app, the participant app and the join/consent pages — registration and sign-in, passkeys, two-factor enrolment, re-authentication, OAuth callbacks, inbound webhooks from wearable and messaging providers, the AI assistant, and the public flows that anonymous poll respondents and consent signers go through. They are not described here and are not part of the API contract: they may change without notice.