---
title: "Get SMS Log"
method: POST
path: "/sms-log/{id}/get-item"
tags: ["SMS Log"]
---

# Get SMS Log

`POST /sms-log/{id}/get-item`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/sms-log/{id}/get-item`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/sms-log/:id/get-item/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve a single SMS Log by ID

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `select` SmsLogSelectSchema: Select schema for SmsLog. Set fields to true to include them in the response.
    - `_id` boolean
    - `createdAt` boolean
    - `updatedAt` boolean
    - `deletedAt` boolean
    - `projectId` boolean
    - `toNumber` boolean
    - `fromNumber` boolean
    - `smsText` boolean
    - `statusMessage` boolean
    - `status` boolean
    - `errorCode` boolean
    - `smsCostInUSDCents` boolean
    - `incidentId` boolean
    - `userId` boolean
    - `alertId` boolean
    - `monitorId` boolean
    - `scheduledMaintenanceId` boolean
    - `statusPageId` boolean
    - `statusPageAnnouncementId` boolean
    - `onCallDutyPolicyId` boolean
    - `onCallDutyPolicyEscalationRuleId` boolean
    - `onCallDutyPolicyScheduleId` boolean
    - `userOnCallLogTimelineId` boolean
    - `teamId` boolean

## Response `200`

Successful response

- object
  - `data` SmsLog
    - `_id` string, uuid: ID of this object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `createdAt` object: Date and Time when the object was created. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `version` number: Object version
    - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `toNumber` object, required: Phone Number SMS was sent to. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `fromNumber` object: Phone Number SMS was sent from. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `smsText` string: Text content of the message. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `statusMessage` string: Status Message (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `status` 'Success' | 'Error' | 'Low Balance' | 'Sending' | 'Sent' | 'Delivered' | 'Undelivered' | 'Failed', required: Status of the SMS sent. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `errorCode` string: Error code returned by the SMS provider (e.g. Twilio error code 30007 for carrier filtering) when the message could not be delivered. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `smsCostInUSDCents` number, required: SMS Cost in USD Cents. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `incidentId` string, uuid: ID of Incident associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `userId` string, uuid: ID of User who initiated this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `alertId` string, uuid: ID of Alert associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `monitorId` string, uuid: ID of Monitor associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `scheduledMaintenanceId` string, uuid: ID of Scheduled Maintenance associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `statusPageId` string, uuid: ID of Status Page associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `statusPageAnnouncementId` string, uuid: ID of Status Page Announcement associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `onCallDutyPolicyId` string, uuid: ID of On-Call Duty Policy associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `onCallDutyPolicyEscalationRuleId` string, uuid: ID of On-Call Duty Policy Escalation Rule associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `onCallDutyPolicyScheduleId` string, uuid: ID of On-Call Duty Policy Schedule associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `userOnCallLogTimelineId` string, uuid: ID of the on-call notification timeline entry this SMS was sent for (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]
    - `teamId` string, uuid: ID of Team associated with this SMS (if any). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read SMS Log], Update: [No access - you don't have permission for this operation]

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)