OpenGov

OpenGov Step Comments API

A Record Step can have **Comments**, which are visible to public Record Contacts, and **Internal Notes**, which are visible to employees only. Comments send Notifications to any employee assigned to a step.

GitHub OpenAPI

Operations 3

GET /v1/{community}/records/{recordID}/workflow-steps/{stepID}/comments List step comments #
POST /v1/{community}/records/{recordID}/workflow-steps/{stepID}/comments Post a step comment #
DELETE /v1/{community}/records/{recordID}/workflow-steps/{stepID}/comments/{commentID} Delete a step comment #

Documentation

📖
Documentation
https://developer.opengov.com/docs/plc/overview
📖
APIReference
https://developer.opengov.com/catalog/plc-api
📖
APIReference
https://developer.opengov.com/catalog/bnp-api
📖
APIReference
https://developer.opengov.com/catalog/pro-api
📖
APIReference
https://developer.opengov.com/catalog/pro-purchase-order-api
📖
APIReference
https://developer.opengov.com/catalog/pro-receipt-api
📖
Documentation
https://developer.opengov.com/docs/vm/overview
📖
APIReference
https://developer.opengov.com/catalog/vm-api
📖
Documentation
https://developer.opengov.com/docs/eam/overview
📖
APIReference
https://developer.opengov.com/catalog/eam-api
📖
APIReference
https://developer.opengov.com/catalog/opendata-public-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opengov/refs/heads/main/openapi/opengov-step-comments-api-openapi.yml

Other Resources

🔗
ChangeLog
https://developer.opengov.com/docs/plc/changelog
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/opengov/refs/heads/main/asyncapi/opengov-permitting-licensing-webhooks.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/opengov/refs/heads/main/conventions/opengov-conventions.yml
🔗
ChangeLog
https://developer.opengov.com/docs/vm/changelog
🔗
ChangeLog
https://developer.opengov.com/docs/eam/changes-log

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/opengov-step-comments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

opengov-step-comments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Opengov Step Comments API
  version: v1
  x-logo:
    url: https://viewpointcloud.blob.core.windows.net/profile-pictures/Frame_778_Sun_Nov_12_2023_17:18:36_GMT+0000_(Coordinated_Universal_Time).png
  description: 'Operations tagged Step Comments across 2 of this provider''s published API definitions: opengov-permitting-licensing-v1-openapi-original.yml, opengov-permitting-licensing-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.plce.opengov.com/plce
  description: Production
security:
- bearerAuth: []
tags:
- name: Step Comments
  description: 'A Record Step can have **Comments**, which are visible to public Record Contacts, and **Internal Notes**, which are visible to employees only.


    Comments send Notifications to any employee assigned to a step.

    '
paths:
  /v1/{community}/records/{recordID}/workflow-steps/{stepID}/comments:
    get:
      summary: List step comments
      operationId: listRecordStepComments
      tags:
      - Step Comments
      parameters:
      - $ref: '#/components/parameters/community'
      - $ref: '#/components/parameters/recordID'
      - $ref: '#/components/parameters/stepID'
      responses:
        '200':
          description: Returns step comments
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RecordStepComment'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Resource not found
        '500':
          description: Internal Server Error
    post:
      summary: Post a step comment
      operationId: postStepComment
      tags:
      - Step Comments
      parameters:
      - $ref: '#/components/parameters/community'
      - $ref: '#/components/parameters/recordID'
      - $ref: '#/components/parameters/stepID'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/RecordStepCommentMutable'
        required: true
      responses:
        '200':
          description: Returns the step comment object
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RecordStepComment'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Resource not found
        '500':
          description: Internal Server Error
    servers:
    - url: https://api.plce.opengov.com/plce
      description: Production
  /v1/{community}/records/{recordID}/workflow-steps/{stepID}/comments/{commentID}:
    delete:
      summary: Delete a step comment
      operationId: removeStepComment
      tags:
      - Step Comments
      parameters:
      - $ref: '#/components/parameters/community'
      - $ref: '#/components/parameters/recordID'
      - $ref: '#/components/parameters/stepID'
      - $ref: '#/components/parameters/commentID'
      responses:
        '200':
          description: Comment Deleted
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Resource not found
        '500':
          description: Internal Server Error
    servers:
    - url: https://api.plce.opengov.com/plce
      description: Production
components:
  parameters:
    commentID:
      name: commentID
      in: path
      description: ID of a comment on a workflow step of a record
      required: true
      schema:
        type: integer
    community:
      name: community
      in: path
      description: Name of the community
      required: true
      schema:
        type: string
    recordID:
      name: recordID
      in: path
      description: ID of the record
      required: true
      schema:
        type: integer
    stepID:
      name: stepID
      in: path
      description: ID of workflow step on a record
      required: true
      schema:
        type: integer
  schemas:
    RecordStepCommentMutable:
      type: object
      example:
        type: record_step_comment
        attributes:
          type: COMMENT
          comment: Hello World
      properties:
        type:
          type: string
          description: Type of the resource
          enum:
          - record_step_comment
        attributes:
          type: object
          properties:
            type:
              type: string
              enum:
              - COMMENT
              - INTERNAL_NOTE
              description: Value indicates the type of comment
            comment:
              type: string
              description: Contents of the comment
    RecordStepComment:
      x-tags:
      - Step Comments
      type: object
      title: The step comment object
      example:
        type: record_step_comment
        id: '10987'
        attributes:
          id: 10987
          type: COMMENT
          comment: Hello World
          createdBy: auth0|60x678x9x5x9xx00709x6880
          createdAt: '2023-11-11T19:00:46.000Z'
      properties:
        id:
          type: integer
        type:
          type: string
          enum:
          - record_step_comment
        attributes:
          type: object
          properties:
            id:
              type: integer
              description: ID that uniquely identifies each comment
            type:
              type: string
              enum:
              - COMMENT
              - INTERNAL_NOTE
              description: Value indicates the type of comment
            comment:
              type: string
              description: Contents of the comment
            createdBy:
              type: string
              description: ID of the user who created this comment
            createdAt:
              type: string
              format: date-time
              description: Timestamp that indicates when this comment was created
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- opengov-permitting-licensing-v1-openapi-original.yml
- opengov-permitting-licensing-v1-openapi.yml
x-og-spec-id: bnp-api-v1
x-og-env-servers:
  production: https://api.bnp.opengov.com
  development: https://api.bnp.ogintegration.us