Data Pools

List Data Pools

get

Retrieves a paginated list of data pools. Can be filtered by name.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Query parameters

filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: name, description

sortstringOptional

Sort field. Prefix with - for descending. Available: 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/data-pool

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "description": "A description of the resource",
      "data_pool_template_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/data-pool",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/data-pool?page=1",
    "last": "https://api.example.com/api/v1/data-pool?page=1",
    "prev": null,
    "next": null
  }
}

Create Data Pool

post

Creates a new data pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Body

application/json

descriptionstring · max: 255 · nullableOptional

namestring · min: 3 · max: 100Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/data-pool

HTTPcURLJavaScriptPython

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

{
  "description": "text",
  "name": "text"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "data_pool_template_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Get Data Pool

get

Retrieves the details of a specific data pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

data_poolstringRequired

The data pool identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: name, description

sortstringOptional

Sort field. Prefix with - for descending. Available: 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/data-pool/{data_pool}

HTTPcURLJavaScriptPython

GET /api/v1/data-pool/{data_pool} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "data_pool_template_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Update Data Pool

put

Updates an existing data pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

data_poolstringRequired

The data pool identifier.

Body

application/json

descriptionstring · max: 255 · nullableOptional

namestring · min: 3 · max: 100Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/data-pool/{data_pool}

HTTPcURLJavaScriptPython

PUT /api/v1/data-pool/{data_pool} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "description": "text",
  "name": "text"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "data_pool_template_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Delete Data Pool

delete

Permanently deletes a specific data pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

data_poolstringRequired

The data pool identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/data-pool/{data_pool}

HTTPcURLJavaScriptPython

DELETE /api/v1/data-pool/{data_pool} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

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

List Data Pool Deduped Data

get

Retrieves a paginated list of deduped data records for a specific data pool. Can be filtered by flow_id, flow_run_id, step_id, entity_type_id, value, created_before, and created_after.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

data_poolstringRequired

The data pool identifier.

Query parameters

filter[flow_id]stringOptional

Filter results by flow_id.

filter[flow_run_id]stringOptional

Filter results by flow_run_id.

filter[step_id]stringOptional

Filter results by step_id.

filter[entity_type_id]stringOptional

Filter results by entity_type_id.

filter[value]stringOptional

Filter results by value.

filter[created_before]stringOptional

Filter results by created_before.

filter[created_after]stringOptional

Filter results by created_after.

includestringOptional

Comma-separated list of relationships to include. Available: flow, flowRun, flowStep, entityType, dataPool

sortstringOptional

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

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/data-pool/{data_pool}/deduped-data

HTTPcURLJavaScriptPython

GET /api/v1/data-pool/{data_pool}/deduped-data HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "description": "A description of the resource",
      "data_pool_template_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/data-pool/{data_pool}/deduped-data",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/data-pool/{data_pool}/deduped-data?page=1",
    "last": "https://api.example.com/api/v1/data-pool/{data_pool}/deduped-data?page=1",
    "prev": null,
    "next": null
  }
}

Download Data Pool Deduped Data

get

Triggers the download of de-dupe data for a specific data pool. A CSV file is generated and added to the file downloads section in the Patchworks dashboard.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

data_poolstringRequired

The data pool identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/data-pool/{data_pool}/deduped-data/download

HTTPcURLJavaScriptPython

GET /api/v1/data-pool/{data_pool}/deduped-data/download HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Import Data Pool Deduped Data

post

Imports de-dupe values into a specific data pool from a CSV file containing value and entity_type_id headers. All records in the import file are added as new items, and any existing items in the data pool are left unchanged.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

data_poolstringRequired

The data pool identifier.

Body

application/json

deduped_data_filestringRequired

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/data-pool/{data_pool}/deduped-data/import

HTTPcURLJavaScriptPython

POST /api/v1/data-pool/{data_pool}/deduped-data/import HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "deduped_data_file": "text"
}

{}

Delete Deduped Data Record

delete

Deletes specific records from a data pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

idstringRequired

The unique identifier of the id.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/data-pool/{id}/deduped-data/delete-records

HTTPcURLJavaScriptPython

DELETE /api/v1/data-pool/{id}/deduped-data/delete-records HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

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