Skip to content

Retrieve All Notes for a Credit Application

Use this API to retrieve all notes associated with a credit application.

GET https://arc-aegis.billtrust.com/creditappcore/api/v1/tenants/{tenantId}/creditapplications/{applicationId}/notes

  • {applicationId} - unique identifier of the credit application

Example:

curl -X GET 'https://arc-aegis.billtrust.com/creditappcore/api/v1/tenants/{tenantId}/creditapplications/{applicationId}/notes' \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Billtrust-Api-Key: <API key value>'

Sample Response Payload

[
  {
    "noteId": "String",
    "notes": "Document creditApplications.csv deleted.",
    "auditData": {
      "...": "..."
    }
  }
]
  • noteId - Unique identifier(GUID) for a Note
  • notes - the content of the Note.
  • auditData - Audit Data Information. Refer to Appendix -> Common for further details.

This sample does not represent all of the data returned. For the full documentation of the available filters and the response body, consult the public Swagger API for the Credit Applications API which can be found at: https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Creditapp%20core%20service%20v1#/Credit_Applications_-_Notes/getTenantCreditApplicationNotes