Skip to content
PayloadPuffin.
Join the waitlist

GET/v1/transformspreview

List the app’s transforms with the destinations and sources that link each one.

Query parameters

  • kind string Optional

    Only transforms of this kind. Omitted: every kind you can read.

    Allowed values: "destination", "source"

Returns

200

The query result.

  • data object[] Required

    Every transform, by name.

    • id string Required

      A transform ID, starting with tfm_.

    • kind string Required

      destination: maps an event payload to the request a destination receives. source: builds an event from the request a source receives. A transform links only to resources of its kind.

      Allowed values: "destination", "source"

    • name string Required

      A name for people.

      1 to 120 characters

    • managed object | null Required

      The managed transform version this transform runs in place of code of its own.

    • publishedAt string | null Required

      When the live code was published. Null until the draft is first published, or when pinned.

    • unpublishedChanges boolean Required

      True when the draft is not the live code: it was never published, or it was saved since.

    • destinations object[] Required

      The destinations that link this transform, by name.

      Show child attributesHide child attributes
      • id string Required

        A destination ID, starting with dst_.

      • name string Required

        Its name.

    • sources object[] Required

      The sources that link this transform, by name.

      Show child attributesHide child attributes
      • id string Required

        A source ID, starting with src_.

      • name string Required

        Its name.

    • createdAt string (date-time) Required

      ISO 8601 timestamp.

    • updatedAt string (date-time) Required

      ISO 8601 timestamp.

  • links object Required

    Links for navigating a paginated collection.

    • next string | null Required

      URI reference for the next page, or null at the end.

Example

Request
curl -X GET "https://api.payloadpuffin.com/v1/transforms" \
  -H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"
Response 200
{
  "data": [
    {
      "id": "id",
      "kind": "destination",
      "name": "name",
      "managed": {
        "provider": "provider",
        "version": 1
      },
      "publishedAt": "publishedAt",
      "unpublishedChanges": true,
      "destinations": [
        {
          "id": "id",
          "name": "name"
        }
      ],
      "sources": [
        {
          "id": "id",
          "name": "name"
        }
      ],
      "createdAt": "createdAt",
      "updatedAt": "updatedAt"
    }
  ],
  "links": {
    "next": "next"
  }
}

Errors

Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.

  • 4XX application/problem+json

    The request was rejected.