Hodoflow / Developers
Sign in
Browse documentation
Help Center →

Release-matched contracts

API reference

Browse every public HTTP operation and the GraphQL factQuery contract with exact scopes, parameters, examples, responses, stable errors, and related guides.

Make your first request Download OpenAPI

Choose a surface

Each surface has its own version, authentication boundary, and response semantics.

53 documented operations

JSON:API

Configure and observe workflows, models, dashboards, integrations, runs, and accounts under /api/json/v1.

Browse resources

GraphQL

Read bounded warehouse records through factQuery, with query variables, filters, time windows, and cost limits.

Inspect factQuery

Webhook ingestion

Authenticate a sender, deduplicate a stable delivery, and enqueue the selected active workflow with a 202 response.

Inspect delivery endpoint

Resources and operations

Authentication

Exchange service-account credentials for short-lived bearer tokens.

1 operation
POST Exchange service-account credentials /api/v1/oauth/token
Workflows

Inspect workflow definitions, authored steps, triggers, and mappings.

11 operations
GET List workflow data mappings /api/json/v1/workflow_data_mappings GET Retrieve a workflow data mapping /api/json/v1/workflow_data_mappings/{id} GET List workflow steps /api/json/v1/workflow_steps GET Retrieve a workflow step /api/json/v1/workflow_steps/{id} GET List workflow triggers /api/json/v1/workflow_triggers GET Retrieve a workflow trigger /api/json/v1/workflow_triggers/{id} GET List workflows /api/json/v1/workflows POST Save workflow builder state /api/json/v1/workflows/save_builder_state GET Retrieve a workflow /api/json/v1/workflows/{id} PATCH Activate a workflow /api/json/v1/workflows/{id}/activate PATCH Deactivate a workflow /api/json/v1/workflows/{id}/deactivate
Runs and monitoring

Follow workflow runs and inspect their per-step outcomes.

3 operations
GET List workflow runs /api/json/v1/workflow_runs GET Retrieve a workflow run /api/json/v1/workflow_runs/{id} GET List workflow run steps /api/json/v1/workflow_runs/{workflow_run_id}/steps
Data models

Manage logical warehouse schemas and their fields.

7 operations
GET List data model fields /api/json/v1/data_model_fields POST Create a data model field /api/json/v1/data_model_fields GET Retrieve a data model field /api/json/v1/data_model_fields/{id} GET List data models /api/json/v1/data_models POST Create a data model /api/json/v1/data_models GET Retrieve a data model /api/json/v1/data_models/{id} PATCH Update a data model /api/json/v1/data_models/{id}
Dashboards

Manage dashboards, widgets, and widget placements.

11 operations
GET List widget placements /api/json/v1/dashboard_widgets GET Retrieve a widget placement /api/json/v1/dashboard_widgets/{id} PATCH Update a widget placement /api/json/v1/dashboard_widgets/{id} GET List dashboards /api/json/v1/dashboards POST Create a dashboard /api/json/v1/dashboards GET Retrieve a dashboard /api/json/v1/dashboards/{id} PATCH Update a dashboard /api/json/v1/dashboards/{id} GET List widgets /api/json/v1/widgets POST Create a widget /api/json/v1/widgets GET Retrieve a widget /api/json/v1/widgets/{id} PATCH Update a widget /api/json/v1/widgets/{id}
Integrations

Inspect connectors, API specifications, and delivery failures.

8 operations
GET List aPI specifications /api/json/v1/api_specs POST Create a aPI specification /api/json/v1/api_specs GET Retrieve a aPI specification /api/json/v1/api_specs/{id} PATCH Update a aPI specification /api/json/v1/api_specs/{id} GET List dead-letter messages /api/json/v1/dead_letter_messages GET Retrieve a dead-letter message /api/json/v1/dead_letter_messages/{id} GET List external connectors /api/json/v1/external_connectors GET Retrieve a external connector /api/json/v1/external_connectors/{id}
Account and organization

Read users, organizations, memberships, and service-account metadata.

10 operations
GET List service accounts /api/json/v1/credentials GET Retrieve a service account /api/json/v1/credentials/{id} GET List organization memberships /api/json/v1/org_memberships GET Retrieve a organization membership /api/json/v1/org_memberships/{id} GET List organizations /api/json/v1/organizations GET Retrieve a organization /api/json/v1/organizations/{id} PATCH Update a organization /api/json/v1/organizations/{id} GET List users /api/json/v1/users GET Retrieve a user /api/json/v1/users/{id} PATCH Update the current user profile /api/json/v1/users/{id}/profile
GraphQL

Query bounded warehouse records through factQuery.

1 operation
POST Query warehouse facts /api/graphql
Webhook ingestion

Accept an inbound delivery and enqueue an active workflow run.

1 operation
POST Ingest a webhook delivery /api/v1/webhooks/{token}