latestOpenAPI 3.0.02026-08-107797148.2 KB

89261af4dd80

Activity Logs1

Agents1

AI1

Alerts1

Allowances1

Authentication Implementations1

Authentication Types1

Blueprints1

Cache Step1

Caches1

Canvas Notes1

Canvas Positions1

Canvas Step Connections1

Canvas Steps1

Certificates1

Company1

Connection Pools1

Connector Instances1

Connectors1

getList Connectors

Cross Reference Lookup Templates1

Cross Reference Lookups1

Data Pools1

Endpoint Templates1

Endpoints1

Entity Types1

Features1

Field Tags1

Filters1

Flow Callbacks1

Flow Folders1

Flow Metric Model Totals1

Flow Metric Value Summaries1

Flow Metric Value Totals1

Flow Routes & Branches1

Flow Run Logs1

Flow Templates1

Flow Version Deployments1

Flow Version Steps1

Flow Version Variables1

Flow Versions1

Flow Webhooks1

Flows1

General1

Job Execution Logs1

Label Templates1

Labels1

Mapping1

Marketplace Apps1

MCP Servers1

Media Files1

Message Broker Queues1

Message Brokers1

Model Filter Values1

Model Notes1

Model Variables1

Multi-Company Profiles1

Notifications1

Oauth1

Operations1

OTC1

Packages1

Payload Metadata1

Request Options1

Scheduled Flows1

Script Languages1

Script Templates1

Script Version Metrics1

Script Versions1

Scripts1

System Templates1

System Types1

Systems1

Tracked Data1

Transforms1

Variables1

Virtual Environment Versions1

Virtual Environments1

Connectors

List Connectors

Retrieves a paginated list of connectors. Can be filtered by canonical_key, system, and other criteria. Note: In the Patchworks dashboard, a connector is known as an instance.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

authenticationImplementation
authenticationImplementation_count
authenticationImplementationExists
authenticationImplementation.authenticationType
authenticationImplementation.system
authenticationImplementation.system.logo
authenticationImplementation.endpoints
authenticationImplementation.endpoints.filters
authenticationImplementation.endpoints.endpointSchema
authenticationImplementation.endpoints.system
authenticationImplementation.endpoints.system.logo
authenticationImplementation.endpoints.entityType
authenticationImplementation.endpoints.fieldTags
authenticationImplementation.system.systemType
variables
variables_count
variablesExists
authenticationImplementation.endpoints.variables
certificate
certificate_count
certificateExists
certificate.user

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

forSystemTemplate
forSession

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name

get/api/v1/connectors

Query parameters

filter[canonical_key]string

Filter results by canonical_key.

filter[forSystemTemplate]string

Filter results by forSystemTemplate.

filter[system]string

Filter results by system.

filter[system_template_id]string

Filter results by system_template_id.

filter[forSession]string

Filter results by forSession.

filter[platformSession]string

Filter results by platformSession.

includestring

Comma-separated list of relationships to include. Available: authenticationImplementation.authenticationType, authenticationImplementation.system, authenticationImplementation.system.logo, authenticationImplementation.endpoints, authenticationImplementation.endpoints.filters, authenticationImplementation.endpoints.endpointSchema, authenticationImplementation.endpoints.system, authenticationImplementation.endpoints.system.logo, authenticationImplementation.endpoints.entityType, authenticationImplementation.endpoints.fieldTags, authenticationImplementation.system.systemType, variables, authenticationImplementation.endpoints.variables, certificate.user

sortstring

Sort field. Prefix with - for descending. Available: name

pageinteger

Page number for pagination.

per_pageinteger

Number of results per page.

Response

Successful response