Process Street Data Sets API

openapi: 3.2.0
info:
  title: Process Street Public Attachments Data Sets API
  version: '1.1'
  description: "The Process Street API is organized around REST. Our API has predictable resource-oriented URLs,\naccepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response\ncodes, authentication, and verbs.\n\nAn [MCP server](https://www.process.st/help/docs/mcp-server/) is also available for integrating with AI agents and tools.\n\n## Core concepts\n\n**Workflow vs Workflow Run.** A **Workflow** (sometimes called a \"playbook\" or template) is the reusable\ndefinition — tasks, form fields, logic, automations. A **Workflow Run** (sometimes called a \"checklist\")\nis one *instance* of running a Workflow. You list available templates via `listWorkflows`; you start one\nvia `createWorkflowRun` (or by scheduling); and you read or update the live state of an in-progress run\nvia the Workflow Runs / Tasks / Form Field Values endpoints. The two are easy to confuse — when in doubt,\n\"Workflow\" is the *blueprint*, \"Workflow Run\" is *one execution*.\n\n**Pages** are similar but standalone: a Page is a content document (no tasks/form fields). A\n**Page Revision** is a versioned snapshot of its content.\n\n## IDs\n\nAll resource IDs are opaque 22-character URL-safe strings (Muids — a base64-encoded UUID). Treat them\nas opaque tokens. Do not parse them, attempt to sort by them, or assume any internal structure. You can\ncompare two IDs for equality with a plain string comparison.\n\n## Dates and times\n\nAll timestamps in requests and responses are ISO-8601, UTC, with millisecond precision\n(e.g. `2024-09-15T14:32:00.000Z`). For date-only fields (typically due dates), use a calendar date\n(`2024-09-15`).\n\n## Pagination\n\nList endpoints page through results using an opaque cursor named `_` (yes, just an underscore).\nThe flow:\n\n1. Call the list endpoint without `_` to get the first page.\n2. Each response includes a `links[]` array. If there are more pages, you'll find an entry with\n   `name: \"next\"` whose `href` is a fully-formed URL you can `GET` directly.\n3. Keep following `next.href` until the `next` link is absent — that's the end.\n\nYou can also reuse the `_` value from one response by passing it as the `_` query parameter on the\nnext request, but **following the `href` is simpler and forward-compatible**.\n\n## Authentication\n\nEvery request must include an API key as `X-API-KEY: <your-key>`. Generate keys from your\norganization settings in the Process Street app. Each key carries the permissions of the user that\ncreated it.\n\n## Idempotency and retries\n\n- `GET` requests are safe to retry on any error.\n- `PUT` requests are idempotent — calling them twice with the same body is equivalent to calling once.\n  Safe to retry on `5xx`.\n- `DELETE` is idempotent (deleting an already-deleted resource returns `404`, which is fine to ignore).\n- `POST` is generally **not** safe to blindly retry. For workflow runs, attach a `referenceId`\n  on create — calling `createWorkflowRun` twice with the same `referenceId` will return the existing\n  run instead of creating a duplicate.\n\n## Errors\n\nErrors are returned as a JSON object with this shape:\n\n```json\n{\n  \"error\": \"human-readable message\",\n  \"errorCode\": \"NotFound\",\n  \"requestId\": \"abc123…\",\n  \"details\": { \"fieldPath\": \"what went wrong\" }\n}\n```\n\n**When present**, branch on `errorCode` rather than regex'ing `error` (we may rewrite the wording). Include\n`requestId` if you contact support so we can find the request in our logs.\n\n`errorCode` and `requestId` are populated on responses generated by the public API exception handler, which\ncovers the great majority of errors. A few low-level failures (e.g. JSON parse failures caught before the\nhandler runs, framework-level routing errors) may return an `ErrorInfo` without these fields. In that case,\nfall back to the HTTP status code (`400`/`401`/`403`/`404`/`409`/`422`/`429`/`5xx`) — its semantics match\nthe corresponding `errorCode` value.\n\n## Rate limits\n\nAll requests are subject to rate limits. If you receive a `429` response, wait for the duration\nspecified in the `Retry-After` header before retrying.\n"
servers:
- url: https://public-api.process.st/api/v1.1
tags:
- name: Data Sets
  description: 'A data set is a structured collection of records that can be linked to

    workflow form fields. Use these endpoints to manage data sets and their

    records.'
  externalDocs:
    url: https://www.process.st/help/docs/data-sets/
    description: Process Street help article
paths:
  /data-sets:
    get:
      tags:
      - Data Sets
      summary: List all data sets
      description: '

        Returns a list of data sets.

        The results are returned 20 at a time, sorted in order of creation date.

        You must use the links section to get the next 20 results.

        '
      operationId: listDataSets
      parameters:
      - name: _
        in: query
        description: 'Opaque pagination cursor. Take this value from the previous response''s `links[]` entry whose `name`

          is `"next"` (typically just follow that link''s `href` instead of reading this value).

          Omit on the first page. If the previous response had no `next` link, there are no more pages.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataSetsResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
    post:
      tags:
      - Data Sets
      summary: Create a data set
      description: Creates a new data set with the given name and field definitions.
      operationId: createDataSet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataSetRequest'
            examples:
              Create a data set:
                summary: Creates a data set with three columns
                value:
                  name: Customers
                  fields:
                  - name: Company
                    fieldType: Text
                  - name: Revenue
                    fieldType: Number
                  - name: Region
                    fieldType: Text
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiDataSetResponse'
        '400':
          description: 'Invalid value for: body'
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
  /data-sets/{dataSetId}:
    get:
      tags:
      - Data Sets
      summary: Get a data set
      description: Returns a data set by its ID, including its field definitions.
      operationId: getDataSet
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiDataSetResponse'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
    put:
      tags:
      - Data Sets
      summary: Update a data set
      description: 'Updates a data set''s name and field definitions. Uses PUT semantics: the full field list is replaced. Returns the updated data set.'
      operationId: updateDataSet
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataSetRequest'
            examples:
              Update a data set:
                summary: Rename a field and add a new one
                value:
                  name: Customers
                  fields:
                  - id: uf183Kg8ZAXCgP_47t1HNA
                    name: Company Name
                    fieldType: Text
                  - id: sVcNjcRUfzQ-cQ1UBaBDTQ
                    name: Revenue
                    fieldType: Number
                  - name: Region
                    fieldType: Text
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiDataSetResponse'
        '400':
          description: 'Invalid value for: body'
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
    delete:
      tags:
      - Data Sets
      summary: Delete a data set
      description: Deletes a data set and all of its records permanently.
      operationId: deleteDataSet
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
  /data-sets/{dataSetId}/records/import:
    post:
      tags:
      - Data Sets
      summary: Import data set records
      description: 'Imports data set records from an external source via CSV upload.


        The data set must already exist and must not contain any duplicate column names.'
      operationId: importDataSetRecords
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      requestBody:
        description: "`strategy`: Defines how data is imported into the system. Possible values are:\n - `Append`: Always append new rows, never touch existing ones\n - `Upsert`: Insert new rows or update existing ones based on matching keys, never delete existing rows.\n - `Sync`: Same as `Upsert`, but also delete any existing rows that are not present in the import file.\n\n`file`: The CSV file to import. The first row must contain the column names. Must not contain duplicate column names.\nThe maximum size for the file is 20 MB.\n\n`key`: The column name to use as the unique identifier for\nthe `Upsert` and `Sync` strategies. This field is required when using\nthe `Upsert` or `Sync` strategies, and must not be provided when using\nthe `Append` strategy."
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportDataSetRowsRequest'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportDataSetRowsResponse'
        '400':
          description: 'Invalid value for: body'
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
  /data-sets/{dataSetId}/records:
    get:
      tags:
      - Data Sets
      summary: List all data set records
      description: '

        Returns a list of data set records for the given query.

        The results are returned 20 at a time, sorted in order of data set record ID.

        You must use the links section to get the next 20 results.

        '
      operationId: listDataSetRecords
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      - name: columns
        in: query
        description: '

          The values of columns to search for.

          It will match them exactly in a case-insensitive manner.

          If there are multiple columns, then the records that match all of them will be returned.


          Example (before being URL-encoded):

          `?columns[lD7FTF9R63xNCLn8w_xMdw]=value_1&columns[iJozi9Lbu_vC2igAV1NLWQ]=value_2`

          '
        required: false
        style: deepObject
        explode: true
        schema:
          type: object
          additionalProperties:
            type: string
      - name: _
        in: query
        description: 'Opaque pagination cursor. Take this value from the previous response''s `links[]` entry whose `name`

          is `"next"` (typically just follow that link''s `href` instead of reading this value).

          Omit on the first page. If the previous response had no `next` link, there are no more pages.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDataSetRowsResponse'
        '400':
          description: 'Invalid value for: query parameters'
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
    post:
      tags:
      - Data Sets
      summary: Create a data set record
      description: Creates a new record in the specified data set.
      operationId: createDataSetRecord
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataSetRowRequest'
            examples:
              Create Data Set row:
                value:
                  cells:
                  - fieldId: qVYbV-y1X597gtzsCydKrw
                    value: cell 1
                  - fieldId: qGdpqLgM2wGG4EiRTVxGjA
                    value: cell 2
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataSetRowResponse'
        '400':
          description: 'Invalid value for: body'
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
  /data-sets/{dataSetId}/records/{dataSetRecordId}:
    get:
      tags:
      - Data Sets
      summary: Get a data set record
      description: Returns a data set record by its ID.
      operationId: getDataSetRecord
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      - name: dataSetRecordId
        in: path
        description: The ID of the Data Set Record
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimplifiedRow'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
    put:
      tags:
      - Data Sets
      summary: Update a data set record
      description: Updates an existing record in a data set.
      operationId: updateDataSetRecord
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      - name: dataSetRecordId
        in: path
        description: The ID of the Data Set Record
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataSetRowRequest'
            examples:
              Update Data Set row:
                value:
                  cells:
                  - fieldId: vl3L6IQZYP_DbP-TziBERQ
                    value: cell 1
                  - fieldId: itDcvlI27AvNL7F9dThBMw
                    value: cell 2
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimplifiedRow'
        '400':
          description: 'Invalid value for: body'
          content:
            text/plain:
              schema:
                type: string
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
    delete:
      tags:
      - Data Sets
      summary: Delete a data set record
      description: Deletes a data set record by its ID.
      operationId: deleteDataSetRecord
      parameters:
      - name: dataSetId
        in: path
        description: The ID of the Data Set
        required: true
        schema:
          type: string
      - name: dataSetRecordId
        in: path
        description: The ID of the Data Set Record
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimplifiedRow'
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
      security:
      - apiKeyAuth: []
      - httpAuth: []
components:
  schemas:
    UpdateDataSetRequest:
      title: UpdateDataSetRequest
      type: object
      required:
      - name
      properties:
        name:
          description: Display name.
          type: string
          minLength: 1
        fields:
          description: Form field definitions or column definitions, depending on context.
          type: array
          minItems: 1
          items:
            title: UpdateDataSetField
            type: object
            required:
            - name
            - fieldType
            properties:
              id:
                title: EntityID
                description: The resource's ID.
                type: string
              name:
                description: Display name.
                type: string
                minLength: 1
              fieldType:
                title: ColumnType
                description: 'Data type of the column.


                  - `Text` — free-form string.

                  - `Number` — numeric value.

                  - `DateTime` — ISO-8601 date-time.

                  '
                type: string
                enum:
                - Text
                - DateTime
                - Number
    ImportDataSetRowsRequest:
      title: ImportDataSetRowsRequest
      type: object
      required:
      - strategy
      - file
      properties:
        strategy:
          description: "How rows in the uploaded CSV are reconciled with the existing data set.\n\n- `Append` — every uploaded row is inserted as a new row (no `key` required;\n  nothing is updated or deleted).\n- `Upsert` — rows whose `key` column matches an existing row are updated in\n  place; new keys are inserted; rows absent from the upload are left untouched.\n- `Sync` — like `Upsert`, but rows in the data set whose key is absent from\n  the upload are deleted, leaving the data set fully in sync with the file.\n"
          type: string
          enum:
          - Append
          - Upsert
          - Sync
        file:
          description: Uploaded file reference. Use the upload endpoint to attach content.
          type: string
          format: binary
        key:
          description: Unique key used to identify this row across imports — matches the data set column referenced by the webhook's `keyColumn`.
          type: string
    ErrorInfo:
      title: ErrorInfo
      type: object
      required:
      - error
      properties:
        error:
          description: 'Human-readable error message. Suitable for logs or for surfacing to end users; do not parse it

            programmatically — use `errorCode` for that.'
          type: string
        details:
          description: 'Optional structured context. Shape depends on the error: for `Validation` errors the keys are field

            paths; for `PaymentRequired` the keys describe the limit that was hit.'
          type: object
          additionalProperties:
            type: string
        errorCode:
          title: ErrorCode
          description: 'Machine-parsable classification of the error. Always set on responses generated by the global

            exception handler. Branch your own error handling on this (not the message text).'
          type: string
          enum:
          - BadRequest
          - Unauthorized
          - PaymentRequired
          - Forbidden
          - NotFound
          - MethodNotAllowed
          - Conflict
          - PayloadTooLarge
          - Validation
          - RateLimited
          - InternalError
        requestId:
          description: Per-request correlation ID. Include this when contacting support so we can find the request in our logs.
          type: string
    PublicApiDataSetResponse:
      title: PublicApiDataSetResponse
      type: object
      required:
      - data
      properties:
        data:
          title: PublicApiDataSet
          description: The resource returned by this request.
          type: object
          required:
          - id
          - createdDate
          - createdBy
          - updatedDate
          - updatedBy
          - organizationId
          - name
          properties:
            id:
              description: The ID of the Data Set
              examples:
              - h4rZ3NTQO4pLgC3dgPBDfA
              type: string
            createdDate:
              description: When the resource was first created. ISO-8601 UTC.
              type: string
              format: date-time
            createdBy:
              description: User who created the resource.
              examples:
              - id: iAaSNCU5lWLYGAi663hO8Q
                email: jane.doe@example.com
                username: Jane Doe
              type: object
              required:
              - id
              - email
              - username
              properties:
                id:
                  title: EntityID
                  description: The resource's ID.
                  type: string
                email:
                  description: The user's email address (also their login identifier).
                  type: string
                username:
                  description: The user's display name (e.g. `Jane Doe`).
                  type: string
            updatedDate:
              description: When the resource was last modified. ISO-8601 UTC.
              type: string
              format: date-time
            updatedBy:
              description: User who last modified the resource.
              examples:
              - id: iAaSNCU5lWLYGAi663hO8Q
                email: jane.doe@example.com
                username: Jane Doe
              type: object
              required:
              - id
              - email
              - username
              properties:
                id:
                  title: EntityID
                  description: The resource's ID.
                  type: string
                email:
                  description: The user's email address (also their login identifier).
                  type: string
                username:
                  description: The user's display name (e.g. `Jane Doe`).
                  type: string
            organizationId:
              title: EntityID
              description: The ID of the organization this resource belongs to.
              type: string
            name:
              description: The data set's display name.
              type: string
            fields:
              description: Column definitions for this data set (name + type per column).
              type: array
              items:
                title: PublicApiDataSetField
                type: object
                required:
                - id
                - createdDate
                - createdBy
                - updatedDate
                - updatedBy
                - name
                - fieldType
                properties:
                  id:
                    title: EntityID
                    description: The resource's ID.
                    type: string
                  createdDate:
                    description: When the resource was first created. ISO-8601 UTC.
                    type: string
                    format: date-time
                  createdBy:
                    description: User who created the resource.
                    examples:
                    - id: iAaSNCU5lWLYGAi663hO8Q
                      email: jane.doe@example.com
                      username: Jane Doe
                    type: object
                    required:
                    - id
                    - email
                    - username
                    properties:
                      id:
                        title: EntityID
                        description: The resource's ID.
                        type: string
                      email:
                        description: The user's email address (also their login identifier).
                        type: string
                      username:
                        description: The user's display name (e.g. `Jane Doe`).
                        type: string
                  updatedDate:
                    description: When the resource was last modified. ISO-8601 UTC.
                    type: string
                    format: date-time
                  updatedBy:
                    description: User who last modified the resource.
                    examples:
                    - id: iAaSNCU5lWLYGAi663hO8Q
                      email: jane.doe@example.com
                      username: Jane Doe
                    type: object
                    required:
                    - id
                    - email
                    - username
                    properties:
                      id:
                        title: EntityID
                        description: The resource's ID.
                        type: string
                      email:
                        description: The user's email address (also their login identifier).
                        type: string
                      username:
                        description: The user's display name (e.g. `Jane Doe`).
                        type: string
                  name:
                    description: Display name.
                    type: string
                  fieldType:
                    title: ColumnType
                    description: 'Data type of the column.


                      - `Text` — free-form string.

                      - `Number` — numeric value.

                      - `DateTime` — ISO-8601 date-time.

                      '
                    type: string
                    enum:
                    - Text
                    - DateTime
                    - Number
            links:
              description: Navigable HATEOAS links to related resources. Each entry has a `name` (RFC-5988 link relation like `self`, `edit`, `related`), an `href` URL, and a `type` (`Api` for callable endpoints, `App` for browser-facing URLs). Prefer following these `href` values over constructing URLs by hand.
              type: array
              items:
                title: Link
                description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
                type: object
                required:
                - name
                - href
                - type
                properties:
                  name:
                    description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
                    type: string
                  href:
                    title: Uri
                    description: URL of the linked resource.
                    examples:
                    - https://api.process.st/api/v1.1/resource/XXX
                    type: string
                  rel:
                    description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
                    type: string
                    enum:
                    - Approval Task
                    - Approvals
                    - Assignees
                    - Comment
                    - Data Set Records
                    - Data Sets
                    - Form Field Values
                    - Subject Task
                    - Task
                    - Tasks
                    - Users
                    - Webhook
                    - Workflow
                    - Workflow Run
                  type:
                    description: Whether this link targets an API endpoint or a Process Street app URL. `Api` — a callable API endpoint you can fetch directly. `App` — a browser-facing URL in the Process Street UI.
                    type: string
                    enum:
                    - Api
                    - App
        links:
          description: 'Pagination links. When the result has more pages, look for an entry with `name: "next"` — its `href` is the URL to fetch the next page. Absence of `next` means there are no more pages. For single-resource responses this array is typically empty.'
          type: array
          items:
            title: Link
            description: A HATEOAS link to a related resource. Use these to navigate between resources without constructing URLs by hand.
            type: object
            required:
            - name
            - href
            - type
            properties:
              name:
                description: Standard link relation name (RFC 5988) indicating this link's role. Common values include `self`, `edit`, `related`, `previous`, `next`.
                type: string
              href:
                title: Uri
                description: URL of the linked resource.
                examples:
                - https://api.process.st/api/v1.1/resource/XXX
                type: string
              rel:
                description: Optional. The kind of resource this link points to (e.g. `Workflow`, `Task`, `Comment`).
                type: string
                enum:
                - Approval Task
                - Approvals
                - Assignees
  

# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/process-street/refs/heads/main/openapi/process-street-data-sets-api-openapi.yml