NMnmi
Applications

List all Applications

This operation returns a list of applications. You can filter applications by:

  • status: Filter by application status (e.g. "draft", "submitted", "approved", etc.)
  • updated_from: Filter applications updated on or after a specific date (YYYY-MM-DD)
  • updated_to: Filter applications updated on or before a specific date (YYYY-MM-DD)
  • package: Filter by package ID
  • sort_dir: Sort by updated_at in ascending or descending order (values: asc, desc, default: desc)

Example: GET /applications?status=submitted&updated_from=2025-01-01&updated_to=2025-03-01&sort_dir=asc

Required scope: applications:read

get/applications

Request

  • Base URL
    https://sandbox.signup.nmi.com/api/v1
  • URL
    https://sandbox.signup.nmi.com/api/v1/applications
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: applications:read

Query parameters

pageinteger

Page number

per_page10 | 20 | 50 | 100

Number of applications per page

packagestring

The unique identifier of the package.

Example:pkg_merrick_tsys

Filter by package id

status'draft' | 'submitted' | 'approved' | 'rejected' | 'underwriter_requested_information' | 'requested_information_sent' | 'boarded'

Filter by application status

updated_fromstring date

Filter applications updated on or after this date (format: YYYY-MM-DD)

updated_tostring date

Filter applications updated on or before this date (format: YYYY-MM-DD)

sort_dir'asc' | 'desc'

Sort by updated_at in ascending or descending order

Response

Successful response

current_pageinteger required

The current page number

last_pageinteger required

The last page number

per_page10 | 20 | 50 | 100 required

The number of items per page (allowed values: 10, 20, 50, 100)

totalinteger required

The total number of items

Example response

{
  "applications": [
    {
      "package_id": "pkg_merrick_tsys",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.