1. Letters
SIMSDIG
  • Academic Periods
    • Get All Academic Periods
      GET
    • Create a Academic Period
      POST
    • Retrieve an Existing Academic Period
      GET
    • Update an Existing Academic Period
      PATCH
    • Delete an Existing Academic Period
      DELETE
  • Attendance
    • Update Attendance Record as Admin
      PATCH
    • Get All Attendance Records
      GET
    • Bulk Upsert Attendance
      POST
    • Check In
      POST
    • Check Out
      POST
    • Run Attendance End-of-Day Cron
      GET
    • Export Attendance
      GET
    • Get Attendance History
      GET
    • Mark Attendance
      POST
    • Get Attendance Recap
      GET
    • Get Attendance Summary
      GET
    • Get Today's Attendance
      GET
    • Get Attendance Settings by User Type
      GET
  • Attendance Session
    • Create Attendance Session
      POST
    • Get Attendance Session
      GET
    • Update Attendance Session
      PATCH
    • Get Attendance Session QR
      GET
    • Get Attendance Session Records
      GET
    • Verify Attendance Session
      POST
  • Auth
    • Change Own Password
    • Get the Current Session
    • Request Password Reset
    • Reset Password
    • Sign In with Email and Password
    • Sign In with Social Provider
    • Sign Up with Email and Password
    • Sign Out the Current User
  • Calendar
    • Query Calendar Items
  • Calendar Feed
    • Get Personal Calendar Feed
    • Get Public iCal feed
    • Generate Calendar Feed Token
    • Revoke Calendar Feed Token
  • Class Subjects
    • Get All Class Subjects
    • Create a Class Subject
    • Retrieve an Existing Class Subject
    • Update an Existing Class Subject
    • Delete an Existing Class Subject
  • Classes
    • Get All Classes
    • Create a Class
    • Retrieve an Existing Class
    • Update Class
    • Delete an Existing Student Copy
    • Get Available Students
    • Assign Students To Class
    • Move Students
    • Unassign Students From Class
    • Batch Create Classes
    • Execute Promotion
    • Get Promotion Sources
  • Regions
    • List Countries
    • List Districts
    • List Provinces
    • List or Search Regencies
    • List Villages
  • Health
    • Health Check
  • Letters
    • Get All Letters
      GET
    • Create a Letter
      POST
    • Retrieve an Existing Letter
      GET
    • Initiate a Letter Action
      POST
    • List Current User Letter
      GET
    • List Recipients
      GET
    • List User Letter
      GET
  • Files
    • Create a Presigned URL
  • Roles
    • Get All Roles
    • Create a Role
    • Retrieve an Existing Role
    • Update an Existing Role
    • Delete an Existing Role
    • Get All Eligible Users for Role
    • Get All Members of Role
    • Add Bulk Member to Role
    • Remove Bulk Members from Role
  • Schedules
    • Get All Schedules
    • Create a Schedule
    • Retrieve an Existing Schedule
    • Update an Existing Schedule
    • Delete an Existing Schedule
  • School Calendar
    • Get All Calendar Events
    • Create a Calendar Event
    • Retrieve an Existing School Calendar
    • Update an Existing School Calendar
    • Delete an Existing School Calendar
  • Settings
    • Retrieve App Settings
    • Update App Settings
    • Get All Attendance Settings
    • Bulk Update Attendance Settings
    • Update Attendance Settings by User Type
    • Update Setting Key Value
    • Upload Background Image
    • Delete Login Background Image
    • Upload Logo Image
    • Delete Logo Image
    • Retrieve Public Settings
  • Time Slots
    • Get All Time Slots
    • Create a Time Slot
    • Retrieve an Existing Time Slot
    • Update an Existing Time Slot
    • Delete an Existing Time Slot
  • Staff
    • Get All Staff
    • Create a Staff
    • Retrieve an Existing Staff
    • Delete an Existing Staff
    • Update an Existing Staff
    • Export All Staff
    • Import Bulk Staffs
  • Users
    • Retrieve User Summary
    • Get All Users
    • Create a User
    • Retrieve an Existing User
    • Delete an Existing User
    • Update an Existing User
    • Update User Image
    • Get User Login History
    • Reset User Password
    • Get Current User
    • Update Current User
    • Update Own Profile Image
  • Statistics
    • Get All Stats
  • Students
    • Get All Students
    • Create a Student
    • Retrieve an Existing Student
    • Delete an Existing Student
    • Update an Existing Student
    • Export All Students
    • Import Bulk Students
  • Subjects
    • Get All Subjects
    • Create a Subject
    • Retrieve an Existing Subject
    • Update an Existing Subject
    • Delete an Existing Subject
  • Teachers
    • Get All Teachers
    • Create a Teacher
    • Retrieve an Existing Teacher
    • Delete an Existing Teacher
    • Update an Existing Teacher
    • Export All Teachers
    • Import Bulk Teachers
  • Schemas
    • AcademicPeriod
    • Actor
    • Address
    • AdminAttendanceRecord
    • AdminBulkUpsertRequest
    • AdminCorrectionRequest
    • AdminMarkRequest
    • AdminRecapItem
    • AgeStats
    • ApiError
    • AttendanceMethod
    • AttendanceRecord
    • AttendanceSession
    • AttendanceSetting
    • AttendanceStatus
    • AttendanceSummary
    • Base
    • bloodType
    • CalendarType
    • CalendarFeedToken
    • CalendarItem
    • CheckInRequest
    • CheckOutRequest
    • Class
    • ClassSubject
    • ClassStats
    • CountryItem
    • EconomyStats
    • EducationHistoryObject
    • EmploymentStats
    • Error
    • ErrorDetail
    • Gender
    • GenderStats
    • HealthStatus
    • HeightStats
    • ImageUploadResult
    • Letter
    • LetterHistory
    • LetterStatus
    • LetterType
    • Location
    • LoginHistory
    • Meta
    • ParentInfo
    • PublicSettings
    • RegionItem
    • Religion
    • ReligionDistribution
    • Roles
    • Schedule
    • SchoolCalendar
    • SettingKvUpdate
    • Staff
    • Student
    • Subjects
    • Teacher
    • TimeSlot
    • TodayAttendance
    • TransportationStats
    • User
    • UserProfile
    • VerifyAttendanceSessionRequest
    • VerifyAttendanceSessionResult
    • WeightStats
    • meta
    • error-detail
    • error
    • academic-period
    • attendance-status
    • admin-correction-request
    • attendance-method
    • attendance-record
    • admin-attendance-record
    • admin-bulk-upsert-request
    • check-in-request
    • check-out-request
    • admin-mark-request
    • admin-recap-item
    • attendance-session
    • verify-attendance-session-request
    • verify-attendance-session-result
    • attendance-summary
    • today-attendance
    • calendar-item
    • calendar-feed-token
    • class-subject
    • class
    • gender
    • country-item
    • region-item
    • health-status
    • actor
    • letter-type
    • letter-status
    • letter-history
    • letter
    • roles
    • schedule
    • calendar-type
    • school-calendar
    • attendance-setting
    • setting-kv-update
    • public-settings
    • time-slot
    • location
    • address
    • parent-info
    • blood-type
    • religion
    • staff
    • gender-stats
    • religion-distribution
    • weight-stats
    • height-stats
    • age-stats
    • transportation-stats
    • class-stats
    • economy-stats
    • employment-stats
    • subjects
    • teacher
    • student
    • user-profile
    • api-error
    • base
    • education-history-object
    • image-upload-result
    • login-history
    • user
  1. Letters

Retrieve an Existing Letter

GET
/letters/{letterId}
Requires authenticated session. Access is determined by runtime ability checks in the route (view:all-letters for unrestricted access, or view:letter when the current session user is the applicant).

Request

Authorization
API Key
Add parameter in cookie
core.session_token
Example:
core.session_token: ********************
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Responses

🟢200
application/json
Body

🟠401unauthorized
🟠403forbidden
🟠404record-not-found
🔴500server-error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/letters/'
Response Response Example
200 - Example 1
{
    "success": true,
    "message": "string",
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0
    },
    "errors": [
        {
            "code": "string",
            "field": "string",
            "message": "string"
        }
    ],
    "result": {
        "id": "string",
        "applicant": {
            "id": "string",
            "name": "string",
            "email": "string",
            "image": "string"
        },
        "reviewer": {
            "id": "string",
            "name": "string",
            "email": "string",
            "image": "string"
        },
        "subject": "string",
        "letterType": "DISPENSATION",
        "status": "PENDING",
        "beginDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z",
        "attachment": "string",
        "reason": "string",
        "recipients": [
            {
                "id": "string",
                "name": "string",
                "email": "string",
                "image": "string"
            }
        ],
        "isPrinted": true,
        "letterNumber": "string",
        "letterDate": "2019-08-24T14:15:22.123Z",
        "letterResult": "string",
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z",
        "history": [
            {
                "status": "PENDING",
                "actor": {
                    "id": "string",
                    "name": "string",
                    "email": "string",
                    "image": "string"
                },
                "note": "string",
                "attachment": "string",
                "timestamp": "2019-08-24T14:15:22.123Z"
            }
        ]
    }
}
Modified at 2026-05-01 04:13:11
Previous
Create a Letter
Next
Initiate a Letter Action
Built with