Get all requirements for an application

​

Retrieve all requirements for a specific application with optional filtering. Returns requirements sorted by priority (required first) then by creation date.

Required permissions: readApplications

Account-scoped: Requires X-Account-ID header

Path Parameters
  • applicationId
    Type: string
    required

    The unique ID of the application

Query Parameters
  • status
    Type: stringenum

    Filter requirements by status

    values
    • pending
    • submitted
    • approved
    • rejected
    • waived
  • type
    Type: stringenum

    Filter requirements by type

    values
    • document
    • field_update
    • question
  • includeSummary
    Type: boolean

    Include summary counts by status and type

Headers
  • x-account-id
    Type: string
    required

    Account ID for the request

Responses
  • application/json
  • 401

    Unauthorized - User not authenticated

  • 403

    Forbidden - User does not have readApplications permission

  • 404

    Application not found

  • application/json
Request Example for get/applications/{applicationId}/requirements
curl 'https://api.pulsecrm.com/applications/{applicationId}/requirements?status=pending&type=document&includeSummary=false' \
  --header 'x-account-id: 2311' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "requirements": [
    {
      "id": 1,
      "applicationId": 1,
      "type": "document",
      "questionText": "string",
      "documentKey": "string",
      "customDocumentName": "string",
      "documentDescription": "string",
      "forOwner": true,
      "ownerUniqueId": "string",
      "fieldSection": "string",
      "fieldPath": "string",
      "fieldLabel": "string",
      "currentValue": "string",
      "reason": "string",
      "priority": "required",
      "status": "pending",
      "requestedBy": 1,
      "requestedAt": "2026-05-23T20:01:14.980Z",
      "resolvedBy": 1,
      "resolvedAt": "2026-05-23T20:01:14.980Z",
      "underwriterNotes": "string",
      "applicantNotes": "string",
      "rejectionReason": "string",
      "createdAt": "2026-05-23T20:01:14.980Z",
      "updatedAt": "2026-05-23T20:01:14.980Z",
      "requestedByUser": {
        "id": 1,
        "name": "string",
        "email": "string"
      }
    }
  ],
  "summary": {
    "total": 1,
    "pending": 1,
    "submitted": 1,
    "approved": 1,
    "rejected": 1,
    "waived": 1,
    "byType": {
      "document": 1,
      "field_update": 1,
      "question": 1
    }
  }
}

Requirements retrieved successfully