SMS Consent: lists consent records for the caller's scope.

GET /api/twilio/sms-consent deprecated

Requires: Twilio.SmsConsent.View, merchant scope.

Newest transition first, with cursor-based paging. Filters (phone number, status) are optional and combined with AND. Paging is keyset / cursor-based, not skip/take: pass `NextContinuationToken` from the previous response back as `ContinuationToken` to fetch the next page. Sorting supports `StatusChangedAt ASC` / `StatusChangedAt DESC` only and defaults to descending.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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-consent" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/sms-consent' `
    -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.smsConsentGetList();

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/twilio/sms-consent', {
  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.SmsConsentGetListAsync();

C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/twilio/sms-consent");
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_consent_get_list()

pip install requests

Python (raw HTTP)

import requests

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

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

Parameters

Name	In	Type	Description
`MaxResultCount` required	query	integer (int32)	Maximum rows per page (1 to `MaxPageSize`). Values at or below zero use the default page size.
`ContinuationToken` required	query	string	Opaque cursor returned by a prior call. `null` for the first page.
`IncludeDeleted` required	query	boolean	Part of the continuation-paging contract (`IContinuationPagedRequest`). Not applied by the consent list endpoint: consent records are never soft-deleted, so there is no soft-delete filter to toggle. Kept to satisfy the interface; ignored here.
`IncludeInactive` required	query	boolean	Part of the continuation-paging contract (`IContinuationPagedRequest`). Not applied by the consent list endpoint: `SmsConsent` has no active/inactive concept. Kept to satisfy the interface; ignored here.
`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` required	query	string	Sort direction. Only `StatusChangedAt ASC` and `StatusChangedAt DESC` are supported: the cursor encodes (StatusChangedAt, Id). Anything else falls back to `StatusChangedAt DESC`.
`PhoneNumber` required	query	string	Optional exact-match E.164 phone number filter.
`Status` required	query	SmsConsentStatus	Optional status filter (opted in / opted out).
`MerchantId` required	query	string (uuid)	Caller-requested merchant scope. Honoured only when the caller holds `SmsConsent.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.