Variables

List Variables

get

Retrieves a paginated list of global variables for a specific connector. Can be filtered by label, key, and value. Note: 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[label]stringOptional

Filter results by label.

filter[key]stringOptional

Filter results by key.

filter[value]stringOptional

Filter results by value.

sortstringOptional

Sort field. Prefix with - for descending. Available: label, key, value

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/variables

HTTPcURLJavaScriptPython

GET /api/v1/variables HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "locked": "example_locked",
      "configurable": "example_configurable",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "modified": "example_modified",
      "pivot": "example_pivot",
      "required": true,
      "advanced": true,
      "alias": "example_alias"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/variables",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/variables?page=1",
    "last": "https://api.example.com/api/v1/variables?page=1",
    "prev": null,
    "next": null
  }
}

Create Variable

post

Creates a new global variable for a connector. 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

Field	Type	Required
label	string	☑
key	string	☑
value	string
secret
locked

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Body

application/json

labelstringRequired

keystringRequired

valuestring · nullableOptional

secretstringOptional

lockedstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/variables

HTTPcURLJavaScriptPython

POST /api/v1/variables HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "label": "text",
  "key": "text",
  "value": "text",
  "secret": "text",
  "locked": "text"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Get Variable

get

Retrieves the details of a specific global variable.

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

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

variablestringRequired

The variable identifier.

Query parameters

filter[label]stringOptional

Filter results by label.

filter[key]stringOptional

Filter results by key.

filter[value]stringOptional

Filter results by value.

sortstringOptional

Sort field. Prefix with - for descending. Available: label, key, value

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/variables/{variable}

HTTPcURLJavaScriptPython

GET /api/v1/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Update Variable

put

Updates an existing global variable.

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

Field	Type	Required
label	string
key	string
value	string
configurable

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

variablestringRequired

The variable identifier.

Body

application/json

labelstringOptional

keystringOptional

valuestring · nullableOptional

configurablestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/variables/{variable}

HTTPcURLJavaScriptPython

PUT /api/v1/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "label": "text",
  "key": "text",
  "value": "text",
  "configurable": "text"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Delete Variable

delete

Permanently deletes a specific global variable.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

variablestringRequired

The variable identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/variables/{variable}

HTTPcURLJavaScriptPython

DELETE /api/v1/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

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