Systems
Lists all systems. Note: In the Patchworks dashboard, a system is known as a connector.
Pagination
Pagination is available for this request. Please see the section on using pagination for more details.
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.
logo
logo_count
logoExists
systemType
systemType_count
systemTypeExists
connectors
connectors_count
connectorsExists
connectors.authenticationImplementation
endpoints
endpoints_count
endpointsExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
authenticationImplementations.variables
authenticationImplementations.authenticationType
variables
variables_count
variablesExists
systemTemplate
systemTemplate_count
systemTemplateExists
systemTemplate.company
systemTemplate.marketplaceCompany
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.
name
withUpdatable
fromMarketplace
fromApp
Available Fields
These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.
systems.id
systems.name
systems.label
systems.colour
systems.system_template_id
systems.version
systems.version_name
systems.system_type_id
systems.protocol
systems.date_format
systems.help_link
systems.created_at
systems.updated_at
systems.rate_limit_unit
systems.rate_limit_duration
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
API key passed in the Authorization header. Format: <api-key>
Filter results by name.
Filter results by canonical_key.
Filter results by withUpdatable.
Filter results by fromMarketplace.
Filter results by fromApp.
Filter results by id.
Filter results by ,.
Comma-separated list of relationships to include. Available: logo, systemType, connectors, connectors.authenticationImplementation, endpoints, authenticationImplementations.variables, authenticationImplementations.authenticationType, variables, systemTemplate.company, systemTemplate.marketplaceCompany, endpoints.preScriptVersion, endpoints.postScriptVersion, endpoints.preScriptVersion.script, endpoints.postScriptVersion.script
Sort field. Prefix with - for descending. Available: name
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": 0,
"name": "string",
"label": "string",
"colour": "string",
"version": 0,
"version_name": "string",
"rate_limit_unit": "string",
"rate_limit_duration": 0,
"system_type_id": 0,
"protocol": "string",
"system_template_id": 0,
"date_format": "string",
"canonical_key": "string",
"help_link": null
}
],
"links": {
"first": "string",
"last": "string",
"prev": null,
"next": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}Creates a new system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
name
string
☑
version_name
string
☑
label
string
☑
colour
string
☑
logo
☑
rate_limit_unit
string
☑
rate_limit_duration
integer
☑
system_type_id
☑
protocol
string
☑
system_template_id
integer
date_format
string
☑
help_link
string
API key passed in the Authorization header. Format: <api-key>
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 174
{
"flow": {
"name": "string",
"label": "string",
"colour": "string",
"system_type_id": 0,
"rate_limit_unit": "string",
"rate_limit_duration": 0,
"protocol": "string",
"date_format": "string"
}
}{
"data": {
"id": 0,
"name": "string",
"label": "string",
"colour": "string",
"version": 0,
"version_name": "string",
"rate_limit_unit": "string",
"rate_limit_duration": 0,
"system_type_id": 0,
"protocol": "string",
"system_template_id": 0,
"date_format": "string",
"canonical_key": "string",
"help_link": null
}
}Retrieves details for a given system. Note: In the Patchworks dashboard, a system is known as a connector.
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.
logo
logo_count
logoExists
systemType
systemType_count
systemTypeExists
connectors
connectors_count
connectorsExists
connectors.authenticationImplementation
endpoints
endpoints_count
endpointsExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
authenticationImplementations.variables
authenticationImplementations.authenticationType
variables
variables_count
variablesExists
systemTemplate
systemTemplate_count
systemTemplateExists
systemTemplate.company
systemTemplate.marketplaceCompany
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.
name
withUpdatable
fromMarketplace
fromApp
Available Fields
These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.
systems.id
systems.name
systems.label
systems.colour
systems.system_template_id
systems.version
systems.version_name
systems.system_type_id
systems.protocol
systems.date_format
systems.help_link
systems.created_at
systems.updated_at
systems.rate_limit_unit
systems.rate_limit_duration
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
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Filter results by name.
Filter results by canonical_key.
Filter results by withUpdatable.
Filter results by fromMarketplace.
Filter results by fromApp.
Filter results by id.
Filter results by ,.
Comma-separated list of relationships to include. Available: logo, systemType, connectors, connectors.authenticationImplementation, endpoints, authenticationImplementations.variables, authenticationImplementations.authenticationType, variables, systemTemplate.company, systemTemplate.marketplaceCompany, endpoints.preScriptVersion, endpoints.postScriptVersion, endpoints.preScriptVersion.script, endpoints.postScriptVersion.script
Sort field. Prefix with - for descending. Available: name
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems/{system} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"id": 0,
"name": "string",
"label": "string",
"colour": "string",
"version": 0,
"version_name": "string",
"rate_limit_unit": "string",
"rate_limit_duration": 0,
"system_type_id": 0,
"protocol": "string",
"system_template_id": 0,
"date_format": "string",
"canonical_key": "string",
"help_link": null
}
}Updates an existing system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
name
string
version_name
string
label
string
colour
string
rate_limit_unit
string
rate_limit_duration
integer
system_type_id
protocol
string
system_template_id
integer
logo
date_format
string
help_link
string
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
PUT /api/v1/systems/{system} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"flow": {
"name": "string",
"label": "string",
"colour": "string",
"rate_limit_unit": "string",
"rate_limit_duration": 0
}
}{
"data": {
"id": 0,
"name": "string",
"label": "string",
"colour": "string",
"version": 0,
"version_name": "string",
"rate_limit_unit": "string",
"rate_limit_duration": 0,
"system_type_id": 0,
"protocol": "string",
"system_template_id": 0,
"date_format": "string",
"canonical_key": "string",
"help_link": null
}
}Deletes a given system. Note: In the Patchworks dashboard, a system is known as a connector.
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Successful response
Unauthenticated
Unauthorized
DELETE /api/v1/systems/{system} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "string"
}Exports a given system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
system_id
integer
☑
API key passed in the Authorization header. Format: <api-key>
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/export HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"system_id": 0
}{
"metadata": {
"company_name": "string",
"system_name": "string",
"exported_at": "2025-01-15T10:30:00.000000Z",
"exported_by": "string",
"system_id": 0,
"system_version": null,
"import_summary": {
"setup_required": {
"connectors_needing_config": 0,
"auth_implementations_needing_credentials": 0,
"variables_needing_values": 0
},
"dependencies": [],
"imported_resources": {
"systems_imported": 0,
"endpoints": 0,
"connectors": 0
},
"next_steps": []
}
},
"system": {
"id": 0,
"name": "string",
"label": "string",
"version": 0
},
"scripts": []
}To be confirmed. Note: In the Patchworks dashboard, a system is known as a connector. Import for import.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
system
☑
metadata
☑
as_marketplace
API key passed in the Authorization header. Format: <api-key>
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/import HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"system": "string",
"metadata": "string",
"as_marketplace": false
}{
"message": "string",
"system_id": 0,
"system_name": "string",
"import_summary": {
"setup_required": {
"connectors_needing_config": 0,
"auth_implementations_needing_credentials": 0,
"variables_needing_values": 0
},
"dependencies": [],
"imported_resources": {
"systems_imported": 0,
"endpoints": 0,
"connectors": 0
},
"next_steps": []
}
}Creates a system from a Postman import. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
collection_url
string
collection_file
precog
API key passed in the Authorization header. Format: <api-key>
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/import-postman HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"collection_url": "string",
"precog": false
}{}Uploads a system to your private marketplace. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
private
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/{system}/upload HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"private": false
}{}Retrieves a paginated list of endpoints for a given system. Can be filtered by name, direction, http_method, and other criteria. Note: In the Patchworks dashboard, a system is known as a connector.
Pagination
Pagination is available for this request. Please see the section on using pagination for more details.
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.
connector
connector_count
connectorExists
system
system_count
systemExists
entityType
entityType_count
entityTypeExists
entityType.fieldTags
endpointTemplate
endpointTemplate_count
endpointTemplateExists
variables
variables_count
variablesExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
fieldTags
fieldTags_count
fieldTagsExists
filters
filters_count
filtersExists
endpointSchema
endpointSchema_count
endpointSchemaExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script
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.
name
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format
Available Fields
These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.
endpoints.id
endpoints.name
endpoints.entity_type_id
endpoints.direction
endpoints.http_method
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
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Filter results by name.
Filter results by system_id.
Filter results by entity_type_id.
Filter results by endpoint.
Filter results by direction.
Filter results by http_method.
Filter results by endpoint_template_id.
Filter results by data_type.
Filter results by deprecated_at.
Filter results by data_path.
Filter results by body_format.
Comma-separated list of relationships to include. Available: connector, system, entityType, entityType.fieldTags, endpointTemplate, variables, authenticationImplementations, fieldTags, filters, endpointSchema, preScriptVersion.script, postScriptVersion.script
Sort field. Prefix with - for descending. Available: name, system_id, entity_type_id, endpoint, direction, http_method, endpoint_template_id, data_type, deprecated_at, data_path, body_format
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems/{system}/endpoints HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": 0,
"name": "string",
"system_id": 0,
"entity_type_id": 0,
"endpoint": "string",
"http_method": "string",
"data_type": "string",
"pagination_method": null,
"deprecated_at": null,
"direction": "string",
"returns_multiple_records": false,
"pre_script_version_id": null,
"post_script_version_id": null,
"data_path": null,
"body_format": "string",
"raw_body": "string",
"modified": false,
"help_link": null,
"disable_header_addition": 0,
"response_encoding": "string"
}
],
"links": {
"first": "string",
"last": "string",
"prev": null,
"next": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}Creates a new endpoint for a given system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
name
string
☑
entity_type_id
integer
endpoint
string
☑
direction
string
☑
returns_multiple_records
☑
http_method
string
☑
data_type
string
☑
pagination_method
string
schema
string
endpoint_template_id
integer
data_path
string
body_format
string
raw_body
string
deprecated_at
help_link
string
disable_header_addition
response_encoding
string
API key passed in the Authorization header. Format: <api-key>
The system identifier.
^[a-zA-Z0-9 \-&\+_]+$Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/{system}/endpoints HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 138
{
"entity_type_id": 0,
"endpoint": "string",
"direction": "string",
"http_method": "string",
"data_type": "string",
"returns_multiple_records": false
}{
"data": {
"id": 0,
"name": "string",
"system_id": 0,
"entity_type_id": 0,
"endpoint": "string",
"http_method": "string",
"data_type": "string",
"pagination_method": null,
"deprecated_at": null,
"direction": "string",
"returns_multiple_records": false,
"pre_script_version_id": null,
"post_script_version_id": null,
"data_path": null,
"body_format": "string",
"raw_body": "string",
"modified": false,
"help_link": null,
"disable_header_addition": 0,
"response_encoding": "string"
}
}To be confirmed. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
wsdl_url
string
update_existing
☑
wsdl_file
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/{system}/endpoints/ingest-wsdl HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"wsdl_url": "string",
"update_existing": false
}{}Retrieves the details for a given system endpoint. Note: In the Patchworks dashboard, a system is known as a connector.
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.
connector
connector_count
connectorExists
system
system_count
systemExists
entityType
entityType_count
entityTypeExists
entityType.fieldTags
endpointTemplate
endpointTemplate_count
endpointTemplateExists
variables
variables_count
variablesExists
authenticationImplementations
authenticationImplementations_count
authenticationImplementationsExists
fieldTags
fieldTags_count
fieldTagsExists
filters
filters_count
filtersExists
endpointSchema
endpointSchema_count
endpointSchemaExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script
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.
name
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format
Available Fields
These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.
endpoints.id
endpoints.name
endpoints.entity_type_id
endpoints.direction
endpoints.http_method
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
system_id
entity_type_id
endpoint
direction
http_method
endpoint_template_id
data_type
deprecated_at
data_path
body_format
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The endpoint identifier.
Filter results by name.
Filter results by system_id.
Filter results by entity_type_id.
Filter results by endpoint.
Filter results by direction.
Filter results by http_method.
Filter results by endpoint_template_id.
Filter results by data_type.
Filter results by deprecated_at.
Filter results by data_path.
Filter results by body_format.
Comma-separated list of relationships to include. Available: connector, system, entityType, entityType.fieldTags, endpointTemplate, variables, authenticationImplementations, fieldTags, filters, endpointSchema, preScriptVersion.script, postScriptVersion.script
Sort field. Prefix with - for descending. Available: name, system_id, entity_type_id, endpoint, direction, http_method, endpoint_template_id, data_type, deprecated_at, data_path, body_format
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems/{system}/endpoints/{endpoint} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"id": 0,
"name": "string",
"system_id": 0,
"entity_type_id": 0,
"endpoint": "string",
"http_method": "string",
"data_type": "string",
"pagination_method": null,
"deprecated_at": null,
"direction": "string",
"returns_multiple_records": false,
"pre_script_version_id": null,
"post_script_version_id": null,
"data_path": null,
"body_format": "string",
"raw_body": "string",
"modified": false,
"help_link": null,
"disable_header_addition": 0,
"response_encoding": "string"
}
}Updates an existing system endpoint. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
name
string
entity_type_id
integer
endpoint
string
direction
string
returns_multiple_records
http_method
string
data_type
string
pagination_method
string
schema
string
endpoint_template_id
integer
data_path
string
body_format
string
raw_body
string
deprecated_at
help_link
string
pre_script_version_id
string
post_script_version_id
string
disable_header_addition
response_encoding
string
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The endpoint identifier.
^[a-zA-Z0-9 \-&\+_]+$Successful response
Unauthenticated
Unauthorized
Validation Error
PUT /api/v1/systems/{system}/endpoints/{endpoint} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"entity_type_id": 0,
"endpoint": "string",
"direction": "string",
"http_method": "string",
"data_type": "string"
}{
"data": {
"id": 0,
"name": "string",
"system_id": 0,
"entity_type_id": 0,
"endpoint": "string",
"http_method": "string",
"data_type": "string",
"pagination_method": null,
"deprecated_at": null,
"direction": "string",
"returns_multiple_records": false,
"pre_script_version_id": null,
"post_script_version_id": null,
"data_path": null,
"body_format": "string",
"raw_body": "string",
"modified": false,
"help_link": null,
"disable_header_addition": 0,
"response_encoding": "string"
}
}Deletes an existing system endpoint. Note: In the Patchworks dashboard, a system is known as a connector.
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The endpoint identifier.
Successful response
Unauthenticated
Unauthorized
DELETE /api/v1/systems/{system}/endpoints/{endpoint} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "string"
}Clones a given system endpoint. Note: In the Patchworks dashboard, a system is known as a connector.
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The endpoint identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/{system}/endpoints/{endpoint}/clone HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "string"
}Retrieves metrics for endpoints associated with a given system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
interval_start
interval_end
interval_unit
string
model_type
string
key
string
keys
managed_companies
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems/{system}/endpoint-metrics HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": 0,
"name": "string",
"direction": "string",
"http_method": "string",
"total_runs": 0,
"success_rate": 0
}
],
"links": {
"first": "string",
"last": "string",
"prev": null,
"next": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}Lists all authentication implementations for a given system. Note: In the Patchworks dashboard, a system is known as a connector.
Pagination
Pagination is available for this request. Please see the section on using pagination for more details.
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.
system
system_count
systemExists
system.systemType
authenticationType
authenticationType_count
authenticationTypeExists
variables
variables_count
variablesExists
endpoints
endpoints_count
endpointsExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script
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.
name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version
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
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Filter results by name.
Filter results by endpoint.
Filter results by method.
Filter results by additional_endpoint_1.
Filter results by additional_endpoint_2.
Filter results by system_id.
Filter results by authentication_type_id.
Filter results by version.
Comma-separated list of relationships to include. Available: system, system.systemType, authenticationType, variables, endpoints, preScriptVersion.script, postScriptVersion.script
Sort field. Prefix with - for descending. Available: name, endpoint, method, additional_endpoint_1, additional_endpoint_2, system_id, authentication_type_id, version
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems/{system}/authentication-implementations HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": 0,
"system_id": 0,
"name": "string",
"method": "string",
"endpoint": "string",
"data_type": "string",
"body_format": "string",
"created_at": "string",
"updated_at": "string"
}
],
"links": {
"first": "string",
"last": "string",
"prev": null,
"next": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}Creates a new authentication implementation for a given system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
name
string
☑
endpoint
string
☑
method
string
☑
data_type
body_format
additional_endpoint_1
string
additional_endpoint_2
string
timeout
integer
authentication_type_id
☑
help_link
string
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/{system}/authentication-implementations HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99
{
"name": "string",
"method": "string",
"endpoint": "string",
"data_type": "string",
"body_format": "string"
}{
"data": {
"id": 0,
"system_id": 0,
"name": "string",
"method": "string",
"endpoint": "string",
"data_type": "string",
"body_format": "string",
"created_at": "string",
"updated_at": "string"
}
}Retrieves a given authentication implementation for a system. Note: In the Patchworks dashboard, a system is known as a connector.
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.
system
system_count
systemExists
system.systemType
authenticationType
authenticationType_count
authenticationTypeExists
variables
variables_count
variablesExists
endpoints
endpoints_count
endpointsExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script
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.
name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version
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
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The authentication implementation identifier.
Filter results by name.
Filter results by endpoint.
Filter results by method.
Filter results by additional_endpoint_1.
Filter results by additional_endpoint_2.
Filter results by system_id.
Filter results by authentication_type_id.
Filter results by version.
Comma-separated list of relationships to include. Available: system, system.systemType, authenticationType, variables, endpoints, preScriptVersion.script, postScriptVersion.script
Sort field. Prefix with - for descending. Available: name, endpoint, method, additional_endpoint_1, additional_endpoint_2, system_id, authentication_type_id, version
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems/{system}/authentication-implementations/{authentication_implementation} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": {
"id": 0,
"system_id": 0,
"name": "string",
"method": "string",
"endpoint": "string",
"data_type": "string",
"body_format": "string",
"created_at": "string",
"updated_at": "string"
}
}Updates an existing authentication implementation for a system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
name
string
endpoint
string
method
string
data_type
body_format
additional_endpoint_1
string
additional_endpoint_2
string
timeout
integer
authentication_type_id
pre_script_version_id
string
post_script_version_id
string
help_link
string
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.
system
system_count
systemExists
system.systemType
authenticationType
authenticationType_count
authenticationTypeExists
variables
variables_count
variablesExists
endpoints
endpoints_count
endpointsExists
preScriptVersion
preScriptVersion_count
preScriptVersionExists
preScriptVersion.script
postScriptVersion
postScriptVersion_count
postScriptVersionExists
postScriptVersion.script
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.
name
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version
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
endpoint
method
additional_endpoint_1
additional_endpoint_2
system_id
authentication_type_id
version
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The authentication implementation identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
PUT /api/v1/systems/{system}/authentication-implementations/{authentication_implementation} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 99
{
"name": "string",
"method": "string",
"endpoint": "string",
"data_type": "string",
"body_format": "string"
}{
"data": {
"id": 0,
"system_id": 0,
"name": "string",
"method": "string",
"endpoint": "string",
"data_type": "string",
"body_format": "string",
"created_at": "string",
"updated_at": "string"
}
}Deletes a given authentication implementation for a system. Note: In the Patchworks dashboard, a system is known as a connector.
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The authentication implementation identifier.
Successful response
Unauthenticated
Unauthorized
DELETE /api/v1/systems/{system}/authentication-implementations/{authentication_implementation} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "string"
}List all variables for a given system. Note: In the Patchworks dashboard, a system is known as a connector.
Pagination
Pagination is available for this request. Please see the section on using pagination for more details.
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.
label
key
value
Available Sorts
These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.
label
key
value
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Filter results by label.
Filter results by key.
Filter results by value.
Sort field. Prefix with - for descending. Available: label, key, value
Page number for pagination.
1Number of results per page.
Successful response
Unauthenticated
Unauthorized
GET /api/v1/systems/{system}/variables HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": 0,
"label": "string",
"key": "string",
"value": "string",
"secret": false,
"created_at": "string",
"updated_at": "string"
}
],
"links": {
"first": "string",
"last": "string",
"prev": null,
"next": null
},
"meta": {
"current_page": 0,
"from": 0,
"last_page": 0,
"links": [],
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}Creates a new variable for a given system. Note: In the Patchworks dashboard, a system is known as a connector.
Validation Rules
These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements
label
string
☑
key
string
☑
value
string
secret
pivot.alias
string
pivot.configurable
pivot.required
pivot.advanced
API key passed in the Authorization header. Format: <api-key>
The system identifier.
Successful response
Unauthenticated
Unauthorized
Validation Error
POST /api/v1/systems/{system}/variables HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"label": "string",
"key": "string",
"value": "string",
"secret": false
}{
"data": {
"id": 0,
"label": "string",
"key": "string",
"value": "string",
"secret": false,
"created_at": "string",
"updated_at": "string"
}
}Deletes a given system variable. Note: In the Patchworks dashboard, a system is known as a connector.
API key passed in the Authorization header. Format: <api-key>
The system identifier.
The variable identifier.
Successful response
Unauthenticated
Unauthorized
DELETE /api/v1/systems/{system}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*
{
"message": "string"
}Last updated
Was this helpful?