Pulse Software

Pulse Software Forms API

API for managing forms and records in Pulse

GitHub OpenAPI

Operations 12

GET /forms/record/recordsByRef Records by Ref ID #
GET /forms/record/recordsCountByRef Records Count by Ref ID #
GET /forms/record/flattenRecordsByRef Flatten Records by Ref ID #
GET /forms/record/recordsByFormId Records by Form ID #
GET /forms/record/recordsCountByFormId Records by Form ID #
GET /forms/record/flattenRecordsByFormId Records by Form ID #
GET /forms/record/flattenRecordsByTag Flatten Records by Tag #
POST /forms/record/flattenRecordsByTag Records by Tag and Fields #
GET /forms/record/recordsCountByTag Records Count by Tag #
POST /forms/record/recordsCountByTag Records by Tag and Fields #
GET /forms/record/recordsByTag Records by Tag #
POST /forms/record/recordsByTag Records by Tag and Fields #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pulse-software/refs/heads/main/openapi/pulse-software-forms-api-api-openapi.yml

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/pulse-software-forms-api-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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

pulse-software-forms-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pulse Public Forms API
  version: 1.0.1
  description: The Pulse API is targeted towards developers looking to automate tasks in Pulse.
  termsOfService: http://www.apache.org/licenses/LICENSE-2.0.html
  contact:
    email: support@pulsesoftware.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://*.pulsesoftware.com/webservices/api
- url: http://*.pulsesoftware.com/webservices/api
tags:
- name: Forms API
  description: API for managing forms and records in Pulse
paths:
  /forms/record/recordsByRef:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Ref ID
      description: 'Retrieve Records submitted by Form ID with or without Date Range.


        **Authorised Roles:** *ICMUser, OnboardingFormsUser, FormsUser, RCMUser*'
      operationId: recordsByRef
      parameters:
      - in: query
        name: refId
        description: Ref ID
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
  /forms/record/recordsCountByRef:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records Count by Ref ID
      description: 'Retrieve Records submitted by Form ID with or without Date Range.


        **Authorised Roles:** *ICMUser, OnboardingFormsUser, FormsUser, RCMUser*'
      operationId: recordsCountByRef
      parameters:
      - in: query
        name: refId
        description: Ref ID
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
  /forms/record/flattenRecordsByRef:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Flatten Records by Ref ID
      description: 'Retrieve Flatten Records submitted by Form ID with or without Date Range.


        **Authorised Roles:** *ICMUser, OnboardingFormsUser, FormsUser, RCMUser*'
      operationId: flattenRecordsByRef
      parameters:
      - in: query
        name: refId
        description: Ref ID
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
  /forms/record/recordsByFormId:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Form ID
      description: 'Retrieve Records submitted by Form ID with or without Date Range.


        **Authorised Roles:** *ICMUser, OnboardingFormsUser, FormsUser, RCMUser*'
      operationId: recordsByFormId
      parameters:
      - in: query
        name: formId
        description: Form ID
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
  /forms/record/recordsCountByFormId:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Form ID
      description: 'Retrieve Records submitted by Form ID with or without Date Range.


        **Authorised Roles:** *ICMUser, OnboardingFormsUser, FormsUser, RCMUser*'
      operationId: recordsCountByFormId
      parameters:
      - in: query
        name: formId
        description: Form ID
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
  /forms/record/flattenRecordsByFormId:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Form ID
      description: 'Retrieve Flatten Records submitted by Form ID with or without Date Range.


        **Authorised Roles:** *ICMUser, OnboardingFormsUser, FormsUser, RCMUser*'
      operationId: flattenRecordsByFormId
      parameters:
      - in: query
        name: formId
        description: Form ID
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
  /forms/record/flattenRecordsByTag:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Flatten Records by Tag
      description: 'Retrieve Flatten Records submitted by Tag with or without Date Range


        **Authorised Roles:** *PRFAdmin*'
      operationId: flattenRecordsByTag
      parameters:
      - in: query
        name: tag
        description: Tag
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
    post:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Tag and Fields
      description: 'Retrieve Records submitted by Tag with or without Date Range filter by Fields


        **Authorised Roles:** *PRFAdmin*'
      operationId: flattenRecordsByTagPost
      parameters:
      - in: query
        name: tag
        description: Tag
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
      requestBody:
        content:
          appliation/json:
            schema:
              type: array
              items:
                type: string
              example:
              - data.TITLE
              - data.FIRSTNAME
              - data.DROMCV2Dhd
        description: Form Fields
        required: true
  /forms/record/recordsCountByTag:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records Count by Tag
      description: 'Retrieve Records Count submitted by Tag with or without Date Range


        **Authorised Roles:** *PRFAdmin*'
      operationId: recordsCountByTag
      parameters:
      - in: query
        name: tag
        description: Tag
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
    post:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Tag and Fields
      description: 'Retrieve Records submitted by Tag with or without Date Range filter by Fields


        **Authorised Roles:** *PRFAdmin*'
      operationId: recordsCountByTagPost
      parameters:
      - in: query
        name: tag
        description: Tag
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
      requestBody:
        content:
          appliation/json:
            schema:
              type: array
              items:
                type: string
              example:
              - data.TITLE
              - data.FIRSTNAME
              - data.DROMCV2Dhd
        description: Form Fields
        required: true
  /forms/record/recordsByTag:
    get:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Tag
      description: 'Retrieve Records submitted by Tag with or without Date Range


        **Authorised Roles:** *PRFAdmin*'
      operationId: recordsByTag
      parameters:
      - in: query
        name: tag
        description: Tag
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
    post:
      security:
      - BearerJWT: []
      tags:
      - Forms API
      summary: Records by Tag and Fields
      description: 'Retrieve Records submitted by Tag with or without Date Range filter by Fields


        **Authorised Roles:** *PRFAdmin*'
      operationId: recordsByTagPost
      parameters:
      - in: query
        name: tag
        description: Tag
        required: true
        schema:
          type: string
      - in: query
        name: submittedStartDate
        description: Submitted Start Date Eg. 01/01/2023
        schema:
          type: string
      - in: query
        name: submittedEndDate
        description: Submitted End Date Eg. 31/01/2023
        schema:
          type: string
      responses:
        200:
          description: OK. Request completed successfully.
        401:
          description: Missing JWT Bearer token in the Authorization header or the given JWT token is invalid.
        403:
          description: The user corresponding to the given JWT token does not have access to this module.
      requestBody:
        content:
          appliation/json:
            schema:
              type: array
              items:
                type: string
              example:
              - TITLE
              - FIRSTNAME
              - DROMCV2Dhd
        description: Form Fields
        required: true
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-Api-Key
      in: header
    BearerJWT:
      type: apiKey
      name: Authorisation
      in: header
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io