System Templates

List System Templates

get

Retrieves a paginated list of system templates. In the Patchworks dashboard, a system is known as a connector.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[name]stringOptional

Filter results by name.

filter[hidden_from_marketplace]stringOptional

Filter results by hidden_from_marketplace.

filter[visible_for_marketplace]stringOptional

Filter results by visible_for_marketplace.

filter[system_type_id]stringOptional

Filter results by system_type_id.

filter[id]stringOptional

Filter results by id.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

filter[platformApp]stringOptional

Filter results by platformApp.

filter[forPlatformApp]stringOptional

Filter results by forPlatformApp.

includestringOptional

Comma-separated list of relationships to include. Available: systemType, company, publicCompany, marketplaceCompany, logo, authenticationImplementationTemplates.variableTemplates, authenticationImplementationTemplates.authenticationType

sortstringOptional

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

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/system-templates

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/system-templates HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/patchworks/system-templates",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/patchworks/system-templates?page=1",
    "last": "https://api.example.com/api/v1/patchworks/system-templates?page=1",
    "prev": null,
    "next": null
  }
}

Create System Template

post

Creates a new system template. In the Patchworks dashboard, a system is known as a connector.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

application/json

labelstringRequired

colourstring · enumRequiredPossible values:

logo_urlstring · uriRequired

versionintegerRequired

version_namestringRequired

rate_limit_unitstring · enumRequiredPossible values:

rate_limit_durationintegerRequired

system_type_idstringRequired

protocolstring · enumRequiredPossible values:

company_idstringRequired

date_formatstringRequired

help_linkstring · nullableOptional

namestringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/patchworks/system-templates

HTTPcURLJavaScriptPython

POST /api/v1/patchworks/system-templates HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "label": "text",
  "colour": "blue",
  "logo_url": "https://example.com",
  "version": 1,
  "version_name": "text",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "system_type_id": "text",
  "protocol": "HTTP",
  "company_id": "text",
  "date_format": "text",
  "help_link": "text",
  "name": "text"
}

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Update System Template

put

Updates an existing system template. In the Patchworks dashboard, a system is known as a connector.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

system_templatestringRequired

The system template identifier.

Body

application/json

labelstringOptional

colourstring · enumOptionalPossible values:

logo_urlstring · uriOptional

versionintegerOptional

version_namestringOptional

rate_limit_unitstring · enumOptionalPossible values:

rate_limit_durationintegerOptional

system_type_idstringOptional

protocolstring · enumOptionalPossible values:

company_idstringOptional

date_formatstringOptional

help_linkstring · nullableOptional

namestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/patchworks/system-templates/{system_template}

HTTPcURLJavaScriptPython

PUT /api/v1/patchworks/system-templates/{system_template} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "label": "text",
  "colour": "blue",
  "logo_url": "https://example.com",
  "version": 1,
  "version_name": "text",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "system_type_id": "text",
  "protocol": "HTTP",
  "company_id": "text",
  "date_format": "text",
  "help_link": "text",
  "name": "text"
}

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Delete System Template

delete

Permanently deletes a specific system template. In the Patchworks dashboard, a system is known as a connector.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

system_templatestringRequired

The system template identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/patchworks/system-templates/{system_template}

HTTPcURLJavaScriptPython

DELETE /api/v1/patchworks/system-templates/{system_template} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}

Install System Template

post

Installs a specific system template into the current company.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

systemTemplatestringRequired

The systemTemplate identifier.

Body

application/json

overwritestringOptional

system_idintegerOptional

platform_app_keystringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/system-templates/{systemTemplate}

HTTPcURLJavaScriptPython

POST /api/v1/system-templates/{systemTemplate} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "overwrite": "text",
  "system_id": 1,
  "platform_app_key": "text"
}

{}