Huddle platform · external API

A read-only API over the Huddle organisation database.

External applications authenticate once with their client credentials, receive a short-lived bearer token, and read organisation data through versioned, documented endpoints. Nothing in this API can create, update or delete data.

Quickstart Browse the API reference

Base URL: https://huddle-api.parentweb.online
Auth: client_id + client_secret → bearer JWT
Token lifetime: 15 minutes
Methods: GET only (plus the token endpoint)
Rate limit: Per consumer, per minute
Spec: OpenAPI 3.1 at /api/openapi.json

How access works

01The Huddle team issues you a client_id and client_secret, scoped to the resources your integration needs.
02Your server exchanges them at POST /api/public/v1/auth/token for a bearer token valid for 15 minutes.
03Send that token on every read request. Refresh it when it expires — token requests are cheap and counted against the same rate limit.
04Errors always arrive as { "error": { "code", "message" } } with a matching HTTP status.

Get a token

curl -X POST https://huddle-api.parentweb.online/api/public/v1/auth/token \
  -H 'Content-Type: application/json' \
  -d '{"client_id":"hud_...","client_secret":"..."}'

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 900,
  "scopes": ["read:*"]
}

Available resources

/api/public/v1/aba-authorization
Read-only view of `aba_authorization`.
/api/public/v1/active-appointments
Read-only view of `active_appointments`.
/api/public/v1/ai-document-review-documents
Read-only view of `ai_document_review_documents`.
/api/public/v1/ai-document-review-prompts
Read-only view of `ai_document_review_prompts`.
/api/public/v1/ai-document-review-submissions
Read-only view of `ai_document_review_submissions`.
/api/public/v1/ais-center-absences
Read-only view of `ais_center_absences`.
/api/public/v1/ais-generated-schedules
Read-only view of `ais_generated_schedules`.
/api/public/v1/ais-schedule-snapshots
Read-only view of `ais_schedule_snapshots`.
/api/public/v1/ais-schedule-templates
Read-only view of `ais_schedule_templates`.
/api/public/v1/ais-staff-schedule-audit
Read-only view of `ais_staff_schedule_audit`.
/api/public/v1/allergy
Read-only view of `allergy`.
/api/public/v1/appointment
Read-only view of `appointment`.
/api/public/v1/assent-withdrawal-flag
Read-only view of `assent_withdrawal_flag`.
/api/public/v1/assent-withdrawal-resolution
Read-only view of `assent_withdrawal_resolution`.
/api/public/v1/assessment-administration
Read-only view of `assessment_administration`.
/api/public/v1/assessment-item
Read-only view of `assessment_item`.
/api/public/v1/assessment-item-type
Read-only view of `assessment_item_type`.
/api/public/v1/assessment-item-value
Read-only view of `assessment_item_value`.
/api/public/v1/assessment-scores
Read-only view of `assessment_scores`.
/api/public/v1/assessment-type
Read-only view of `assessment_type`.
/api/public/v1/assessment-type-scores
Read-only view of `assessment_type_scores`.
/api/public/v1/assessment-types
Read-only view of `assessment_types`.
/api/public/v1/assessment-utilized-in-diagnosis
Read-only view of `assessment_utilized_in_diagnosis`.
/api/public/v1/assessments
Read-only view of `assessments`.
/api/public/v1/authorization-tracking
Read-only view of `authorization_tracking`.
/api/public/v1/binder-check
Read-only view of `binder_check`.
/api/public/v1/center
Read-only view of `center`.
/api/public/v1/chart
Read-only view of `chart`.
/api/public/v1/chart-flag
Read-only view of `chart_flag`.
/api/public/v1/chart-flags-count-view
Read-only view of `chart_flags_count_view`.
/api/public/v1/checked-out-sessions-today
Read-only view of `checked_out_sessions_today`.
/api/public/v1/checkin
Read-only view of `checkin`.
/api/public/v1/client
Read-only view of `client`.
/api/public/v1/client-allergy
Read-only view of `client_allergy`.
/api/public/v1/client-center-history
Read-only view of `client_center_history`.
/api/public/v1/client-connected-contact-connection
Read-only view of `client_connected_contact_connection`.
/api/public/v1/client-connected-contact-connection-new
Read-only view of `client_connected_contact_connection_new`.
/api/public/v1/client-diagnosis
Read-only view of `client_diagnosis`.
/api/public/v1/client-incident-report
Read-only view of `client_incident_report`.
/api/public/v1/client-insurance
Read-only view of `client_insurance`.
/api/public/v1/client-motivator
Read-only view of `client_motivator`.
/api/public/v1/client-stats
Read-only view of `client_stats`.
/api/public/v1/client-status-history
Read-only view of `client_status_history`.
/api/public/v1/client-transition-planning
Read-only view of `client_transition_planning`.
/api/public/v1/conditions
Read-only view of `conditions`.
/api/public/v1/connected-contact
Read-only view of `connected_contact`.
/api/public/v1/connected-contact-new
Read-only view of `connected_contact_new`.
/api/public/v1/coordination-of-care
Read-only view of `coordination_of_care`.
/api/public/v1/current-checked-in
Read-only view of `current_checked_in`.
/api/public/v1/data-point
Read-only view of `data_point`.
/api/public/v1/diagnosis
Read-only view of `diagnosis`.
/api/public/v1/dictation-log
Read-only view of `dictation_log`.
/api/public/v1/discipline
Read-only view of `discipline`.
/api/public/v1/fee-schedule
Read-only view of `fee_schedule`.
/api/public/v1/fee-schedule-view
Read-only view of `fee_schedule_view`.
/api/public/v1/fluency-run
Read-only view of `fluency_run`.
/api/public/v1/global-annotation
Read-only view of `global_annotation`.
/api/public/v1/global-config
Read-only view of `global_config`.
/api/public/v1/handwashing-log
Read-only view of `handwashing_log`.
/api/public/v1/holidays
Read-only view of `holidays`.
/api/public/v1/insurance-company
Read-only view of `insurance_company`.
/api/public/v1/job-title
Read-only view of `job_title`.
/api/public/v1/job-title-discipline
Read-only view of `job_title_discipline`.
/api/public/v1/job-title-mapping
Read-only view of `job_title_mapping`.
/api/public/v1/learner-level
Read-only view of `learner_level`.
/api/public/v1/learner-profile-category
Read-only view of `learner_profile_category`.
/api/public/v1/learner-profile-input
Read-only view of `learner_profile_input`.
/api/public/v1/learner-profile-save
Read-only view of `learner_profile_save`.
/api/public/v1/learner-update
Read-only view of `learner_update`.
/api/public/v1/license-certification
Read-only view of `license_certification`.
/api/public/v1/license-certification-credentialing-body
Read-only view of `license_certification_credentialing_body`.
/api/public/v1/location
Read-only view of `location`.
/api/public/v1/mastered-target
Read-only view of `mastered_target`.
/api/public/v1/note-banned-text
Read-only view of `note_banned_text`.
/api/public/v1/note-generation-log
Read-only view of `note_generation_log`.
/api/public/v1/note-question
Read-only view of `note_question`.
/api/public/v1/note-question-ai-review-prompt
Read-only view of `note_question_ai_review_prompt`.
/api/public/v1/note-question-answer
Read-only view of `note_question_answer`.
/api/public/v1/note-question-choice
Read-only view of `note_question_choice`.
/api/public/v1/note-question-sentence
Read-only view of `note_question_sentence`.
/api/public/v1/note-question-two-tiered-choice-primary
Read-only view of `note_question_two_tiered_choice_primary`.
/api/public/v1/note-question-two-tiered-choice-secondary
Read-only view of `note_question_two_tiered_choice_secondary`.
/api/public/v1/note-question-type
Read-only view of `note_question_type`.
/api/public/v1/note-template
Read-only view of `note_template`.
/api/public/v1/note-template-question-bridge
Read-only view of `note_template_question_bridge`.
/api/public/v1/notifications
Read-only view of `notifications`.
/api/public/v1/parent-contact-log
Read-only view of `parent_contact_log`.
/api/public/v1/parent-contact-meeting-barrier-option
Read-only view of `parent_contact_meeting_barrier_option`.
/api/public/v1/parent-contact-parent-reported-reason-option
Read-only view of `parent_contact_parent_reported_reason_option`.
/api/public/v1/parent-training-goal
Read-only view of `parent_training_goal`.
/api/public/v1/parent-training-goal-status-option
Read-only view of `parent_training_goal_status_option`.
/api/public/v1/parent-training-log
Read-only view of `parent_training_log`.
/api/public/v1/parent-training-log-goal-entry
Read-only view of `parent_training_log_goal_entry`.
/api/public/v1/reports
Read-only view of `reports`.
/api/public/v1/rules-engine-logs
Read-only view of `rules_engine_logs`.
/api/public/v1/scheduler-centers
Read-only view of `scheduler_centers`.
/api/public/v1/school
Read-only view of `school`.
/api/public/v1/service
Read-only view of `service`.
/api/public/v1/signature
Read-only view of `signature`.
/api/public/v1/spot-goal
Read-only view of `spot_goal`.
/api/public/v1/staff
Read-only view of `staff`.
/api/public/v1/staff-certification-licensure
Read-only view of `staff_certification_licensure`.
/api/public/v1/staff-education
Read-only view of `staff_education`.
/api/public/v1/staff-insurance-credentialing
Read-only view of `staff_insurance_credentialing`.
/api/public/v1/staff-leave
Read-only view of `staff_leave`.
/api/public/v1/standard-rate
Read-only view of `standard_rate`.
/api/public/v1/suggested-edit
Read-only view of `suggested_edit`.
/api/public/v1/supervising-bcba-connection
Read-only view of `supervising_bcba_connection`.
/api/public/v1/supervising-staff-connection
Read-only view of `supervising_staff_connection`.
/api/public/v1/treatment-plan
Read-only view of `treatment_plan`.
/api/public/v1/treatment-plan-ai-review-audit
Read-only view of `treatment_plan_ai_review_audit`.
/api/public/v1/treatment-plan-payer-rule
Read-only view of `treatment_plan_payer_rule`.
/api/public/v1/treatment-plan-revision
Read-only view of `treatment_plan_revision`.
/api/public/v1/trial-entry
Read-only view of `trial_entry`.
/api/public/v1/trial-entry-edit
Read-only view of `trial_entry_edit`.