Payload Metadata

List Payload Metadata

get

Retrieves a paginated list of payload metadata records. Can be filtered by id, flow_run_id, flow_step_id, and flow_log_id.

Authorizations

AuthorizationstringRequired

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

Query parameters

filter[id]stringOptional

Filter results by id.

filter[flow_run_id]stringOptional

Filter results by flow_run_id.

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

filter[flow_log_id]stringOptional

Filter results by flow_log_id.

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/payload-metadata

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

{
  "data": [
    {
      "id": 0,
      "flow_version_id": 0,
      "flow_step_id": 0,
      "flow_run_id": "string",
      "payload_store_reference": "string",
      "payload_size": 0,
      "dropped": false
    }
  ],
  "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
  }
}

Get Payload Metadata

get

Retrieves the details of a specific payload metadata record.

Authorizations

AuthorizationstringRequired

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

Path parameters

payload_metadatumstringRequired

The payload metadatum identifier.

Query parameters

filter[id]stringOptional

Filter results by id.

filter[flow_run_id]stringOptional

Filter results by flow_run_id.

filter[flow_step_id]stringOptional

Filter results by flow_step_id.

filter[flow_log_id]stringOptional

Filter results by flow_log_id.

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/payload-metadata/{payload_metadatum}

GET /api/v1/payload-metadata/{payload_metadatum} 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",
    "flow_version_id": 1,
    "flow_step_id": 1,
    "flow_run_id": 1,
    "payload_store_reference": "example_payload_store_reference",
    "payload_size": "example_payload_size",
    "dropped": "example_dropped"
  }
}

Get Meta

get

To be confirmed.

Authorizations

AuthorizationstringRequired

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

Path parameters

payloadMetadatumstringRequired

The payloadMetadatum identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/payload-metadata/{payloadMetadatum}/meta

GET /api/v1/payload-metadata/{payloadMetadatum}/meta HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Download Payload Metadata

get

Downloads the payload data for a specific payload metadata record.

Authorizations

AuthorizationstringRequired

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

Path parameters

payloadMetadatumstringRequired

The payloadMetadatum identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get/api/v1/payload-metadata/{payloadMetadatum}/download

GET /api/v1/payload-metadata/{payloadMetadatum}/download HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}