SMS Log: lists outbound SMS delivery records for the caller's scope.

GET /api/twilio/sms-log deprecated

Requires: Twilio.SmsLog.View, merchant scope.

Newest first, with cursor-based paging. Each row is one outbound message and carries its current lifecycle status, updated in place as Twilio reports delivery progress. Tenant and merchant scoping is enforced server-side from the caller's operating context: merchant-scoped users see only their own merchant, while a caller holding `SmsLog.ViewAllMerchants` may target a specific merchant or leave the scope open. Recipient and sender numbers are returned masked to their last four digits; the full values never leave the server on this surface. Paging is cursor-based, not skip/take. Pass `NextContinuationToken` from the previous response back as `ContinuationToken`; a `null` token in the response means there are no further pages. Sorting supports the send timestamp only and defaults to newest first.

Try this in the console

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/twilio/sms-log" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/sms-log' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, MessagingApi } from '@winkpg/winkpg-api';

const api = new MessagingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.smsLogGetList();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/twilio/sms-log', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MessagingApi(config);
var result = await api.SmsLogGetListAsync();

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/twilio/sms-log");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MessagingApi(client)
    result = api.sms_log_get_list()

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/twilio/sms-log",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`MaxResultCount` required	query	integer (int32)	Maximum rows per page, capped at 100.
`ContinuationToken` required	query	string	Opaque cursor returned by a prior call. `null` for the first page.
`IncludeDeleted` required	query	boolean	Disables the soft-delete filter. Honoured only for callers with the relevant permission.
`IncludeInactive` required	query	boolean	Disables the IsActive filter. Honoured only for callers with the relevant permission.
`IncludeApproxTotalCount` required	query	boolean	Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before.
`Sorting.Field` required	query	string
`Sorting.Descending` required	query	boolean
`Filter.Logic` required	query	FilterLogic
`Filter.Rules` required	query	array of FilterRule
`Filter.Groups` required	query	array of FilterGroup
`MerchantId` required	query	string (uuid)	Caller-requested merchant scope. Honoured only when the caller holds `SmsLog.ViewAllMerchants`; otherwise the caller's own merchant is used.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.