JSON:API · v1

Integrations

Inspect connectors, API specifications, and delivery failures.

Bearer authentication api_read / api_write by operation Stable

Operations


                  /api/json/v1/api_specs


                  /api/json/v1/api_specs


                  /api/json/v1/api_specs/{id}


                  /api/json/v1/api_specs/{id}


                  /api/json/v1/external_connectors


                  /api/json/v1/external_connectors/{id}

These are the reviewed public attributes. Fields omitted from this contract are not part of the API, even when they exist internally.

API specification type: api_spec 12 fields

Public JSON:API resource object for aPI specifications.

Field	Type	Presence	Description
external_connector_id	string \| null	Optional · nullable	Attached external connector identifier, when configured.
format	enum: json \| yaml	Required	Serialization of the uploaded document. Field included by default.
name	string	Required	Human label for the imported spec, e.g. 'Stripe API'. Field included by default.
openapi_version	string \| null	Optional · nullable	Declared spec version, e.g. '3.0.3', '3.1.0', or '2.0' (Swagger). Field included by default.
operations	array<object>	Required	Normalized operations from the Parser. Each: operation_ref, method, path, params, request_schema, response_schema, request_fingerprint, response_fingerprint.
organization_id	string	Required	Organization that owns the resource.
provider_slug	string \| null	Optional · nullable	Set when the document came from a bundled provider (`Dash.Integrations.ProviderCatalog`) rather than an upload. Routes a bundled-spec version bump through the re-upload reconciler.
raw_document	string	Required	The original uploaded document, verbatim (JSON or YAML text).
security_schemes	object	Required	components.securitySchemes from the spec; informs connector auth_type. Field included by default.
servers	array<object>	Required	Normalized server entries (%{"url" => ..., "description" => ...}). Field included by default.
title	string \| null	Optional · nullable	info.title from the spec. Field included by default.
version	string \| null	Optional · nullable	info.version from the spec. Field included by default.

External connector type: external_connector 9 fields

Public JSON:API resource object for external connectors.

Field	Type	Presence	Description
auth_type	enum: none \| oauth2 \| api_key \| bearer_token \| basic_auth \| hmac	Required	Auth type returned by the public contract.
config	object \| null	Optional · nullable	Stores base_url, region, client_id, etc. A `rate_limit` block here caps how fast workflow steps may call this provider — see `Dash.Workflows.RateLimiter`. Field included by default.
description	string \| null	Optional · nullable	Optional notes can describe the connector's purpose, owner, and related runbooks. Field included by default.
direction	enum: inbound \| outbound \| null	Optional · nullable	Direction returned by the public contract.
name	string	Required	e.g., 'Shopify Production' or 'SendGrid API'. Field included by default.
organization_id	string	Required	Organization that owns the resource.
provider_slug	string \| null	Optional · nullable	Which bundled provider (`Dash.Integrations.ProviderCatalog`) this connection was installed from. A tag, not an identity: an org may hold several connections to the same provider. Field included by default.
status	enum: unverified \| verified \| failing \| null	Optional · nullable	Current outcome status.
type	enum: http \| s3 \| snowflake \| null	Optional · nullable	Determines which driver handles the connection. Field included by default.