Endpoints

Index

get

List all field tags.

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[entity_type_id]stringOptional

Filter results by entity_type_id.

filter[store_as]stringOptional

Filter results by store_as.

filter[is_required]stringOptional

Filter results by is_required.

includestringOptional

Comma-separated list of relationships to include. Available: entityType

sortstringOptional

Sort field. Prefix with - for descending. Available: name, entity_type_id, store_as, is_required

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/endpoints/{endpoint}/field-tags

HTTPcURLJavaScriptPython

GET /api/v1/endpoints/{endpoint}/field-tags HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "field_path": "example_field_path",
      "tags": "example_tags",
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "variables": "example_variables",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example",
      "system_id": 1,
      "system": {},
      "entity_type_id": 1,
      "entity_type": {},
      "endpoint": "example_endpoint",
      "http_method": "CONNECT",
      "data_type": "csv",
      "pagination_method": "Custom relative URI",
      "deprecated_at": "2025-01-15T10:30:00.000000Z",
      "direction": "Send",
      "returns_multiple_records": true,
      "pre_script_version_id": 1,
      "post_script_version_id": 1,
      "endpoint_schema": [],
      "field_tags": [],
      "data_path": [],
      "body_format": "none",
      "raw_body": [],
      "filters": [],
      "modified": [],
      "help_link": [],
      "authentication_implementations": [],
      "pre_script_version": "example_pre_script_version",
      "post_script_version": "example_post_script_version",
      "disable_header_addition": true,
      "response_encoding": "base64"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/endpoints/{endpoint}/field-tags",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/endpoints/{endpoint}/field-tags?page=1",
    "last": "https://api.example.com/api/v1/endpoints/{endpoint}/field-tags?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

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
field_path		☑
tags
tags.*.field_tag_id		☑
tags.*.field_path	string	☑
tags.*.tracked

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

Body

application/json

field_pathstringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/endpoints/{endpoint}/field-tags

HTTPcURLJavaScriptPython

POST /api/v1/endpoints/{endpoint}/field-tags HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "field_path": "example_field_path",
  "tags": "example_tags"
}

{
  "data": {
    "id": 1,
    "field_path": "example_field_path",
    "tags": "example_tags",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "system_id": 1,
    "system": {},
    "entity_type_id": 1,
    "entity_type": {},
    "endpoint": "example_endpoint",
    "http_method": "CONNECT",
    "data_type": "csv",
    "pagination_method": "Custom relative URI",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "direction": "Send",
    "returns_multiple_records": true,
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "endpoint_schema": [],
    "field_tags": [],
    "data_path": [],
    "body_format": "none",
    "raw_body": [],
    "filters": [],
    "modified": [],
    "help_link": [],
    "authentication_implementations": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "disable_header_addition": true,
    "response_encoding": "base64"
  }
}

Update

put

Update an existing field tag.

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

field_tagstringRequired

The field tag identifier.

Responses

200

Successful response

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/endpoints/{endpoint}/field-tags/{field_tag}

HTTPcURLJavaScriptPython

PUT /api/v1/endpoints/{endpoint}/field-tags/{field_tag} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Destroy

delete

Delete a field tag.

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

field_tagstringRequired

The field tag identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

delete

/api/v1/endpoints/{endpoint}/field-tags/{field_tag}

HTTPcURLJavaScriptPython

DELETE /api/v1/endpoints/{endpoint}/field-tags/{field_tag} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Index

get

List all pagination.

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/endpoints/{endpoint}/pagination

HTTPcURLJavaScriptPython

GET /api/v1/endpoints/{endpoint}/pagination HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "field_path": "example_field_path",
      "tags": "example_tags",
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "variables": "example_variables",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example",
      "system_id": 1,
      "system": {},
      "entity_type_id": 1,
      "entity_type": {},
      "endpoint": "example_endpoint",
      "http_method": "CONNECT",
      "data_type": "csv",
      "pagination_method": "Custom relative URI",
      "deprecated_at": "2025-01-15T10:30:00.000000Z",
      "direction": "Send",
      "returns_multiple_records": true,
      "pre_script_version_id": 1,
      "post_script_version_id": 1,
      "endpoint_schema": [],
      "field_tags": [],
      "data_path": [],
      "body_format": "none",
      "raw_body": [],
      "filters": [],
      "modified": [],
      "help_link": [],
      "authentication_implementations": [],
      "pre_script_version": "example_pre_script_version",
      "post_script_version": "example_post_script_version",
      "disable_header_addition": true,
      "response_encoding": "base64"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/endpoints/{endpoint}/pagination",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/endpoints/{endpoint}/pagination?page=1",
    "last": "https://api.example.com/api/v1/endpoints/{endpoint}/pagination?page=1",
    "prev": null,
    "next": null
  }
}

Update

put

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
variables
variables.*.alias	string	☑
variables.*.value	string
request_options
request_options.*.key	string	☑
request_options.*.alias	string	☑
request_options.*.value	string

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

Body

application/json

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/endpoints/{endpoint}/pagination

HTTPcURLJavaScriptPython

PUT /api/v1/endpoints/{endpoint}/pagination HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "variables": "example_variables",
  "request_options": []
}

{
  "data": {
    "id": 1,
    "field_path": "example_field_path",
    "tags": "example_tags",
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "system_id": 1,
    "system": {},
    "entity_type_id": 1,
    "entity_type": {},
    "endpoint": "example_endpoint",
    "http_method": "CONNECT",
    "data_type": "csv",
    "pagination_method": "Custom relative URI",
    "deprecated_at": "2025-01-15T10:30:00.000000Z",
    "direction": "Send",
    "returns_multiple_records": true,
    "pre_script_version_id": 1,
    "post_script_version_id": 1,
    "endpoint_schema": [],
    "field_tags": [],
    "data_path": [],
    "body_format": "none",
    "raw_body": [],
    "filters": [],
    "modified": [],
    "help_link": [],
    "authentication_implementations": [],
    "pre_script_version": "example_pre_script_version",
    "post_script_version": "example_post_script_version",
    "disable_header_addition": true,
    "response_encoding": "base64"
  }
}

Index

get

List all schema.

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/endpoints/{endpoint}/schema

HTTPcURLJavaScriptPython

GET /api/v1/endpoints/{endpoint}/schema HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "field_path": "example_field_path",
      "tags": "example_tags",
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "variables": "example_variables",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example",
      "system_id": 1,
      "system": {},
      "entity_type_id": 1,
      "entity_type": {},
      "endpoint": "example_endpoint",
      "http_method": "CONNECT",
      "data_type": "csv",
      "pagination_method": "Custom relative URI",
      "deprecated_at": "2025-01-15T10:30:00.000000Z",
      "direction": "Send",
      "returns_multiple_records": true,
      "pre_script_version_id": 1,
      "post_script_version_id": 1,
      "endpoint_schema": [],
      "field_tags": [],
      "data_path": [],
      "body_format": "none",
      "raw_body": [],
      "filters": [],
      "modified": [],
      "help_link": [],
      "authentication_implementations": [],
      "pre_script_version": "example_pre_script_version",
      "post_script_version": "example_post_script_version",
      "disable_header_addition": true,
      "response_encoding": "base64"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/endpoints/{endpoint}/schema",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/endpoints/{endpoint}/schema?page=1",
    "last": "https://api.example.com/api/v1/endpoints/{endpoint}/schema?page=1",
    "prev": null,
    "next": null
  }
}

Index

get

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

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint 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/endpoints/{endpoint}/variables

HTTPcURLJavaScriptPython

GET /api/v1/endpoints/{endpoint}/variables HTTP/1.1
Host: core.wearepatchworks.com
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/endpoints/{endpoint}/variables",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/endpoints/{endpoint}/variables?page=1",
    "last": "https://api.example.com/api/v1/endpoints/{endpoint}/variables?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

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
pivot.alias	string
pivot.configurable
pivot.required
pivot.advanced

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

Body

application/json

labelstringRequired

keystringRequired

valuestringOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/endpoints/{endpoint}/variables

HTTPcURLJavaScriptPython

POST /api/v1/endpoints/{endpoint}/variables HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "label": "My Label",
  "key": "example_key",
  "value": "example_value",
  "secret": "example_secret",
  "pivot": {
    "alias": "example_alias",
    "configurable": "example_configurable",
    "required": "example_required",
    "advanced": "example_advanced"
  }
}

{
  "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"
  }
}

Destroy

delete

Delete a variable.

Authorizations

ApiKeyAuth

Path parameters

endpointstringRequired

The endpoint identifier.

variablestringRequired

The variable identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

delete

/api/v1/endpoints/{endpoint}/variables/{variable}

HTTPcURLJavaScriptPython

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

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