# GET /api/twilio/sms-consent

SMS Consent: lists consent records for the caller's 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.

**Operation ID:** `smsConsentGetList`

## Authorization

Requires: Twilio.SmsConsent.View, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Twilio.SmsConsent.View`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| MaxResultCount | query | no | integer(int32) | Maximum rows per page (1 to `MaxPageSize`). Values at or below zero use the default page size. |
| ContinuationToken | query | no | string | Opaque cursor returned by a prior call. `null` for the first page. |
| IncludeDeleted | query | no | 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 | query | no | 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 | query | no | 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 | query | no | string | Sort direction. Only `StatusChangedAt ASC` and `StatusChangedAt DESC` are supported:  the cursor encodes (StatusChangedAt, Id). Anything else falls back to `StatusChangedAt DESC`. |
| PhoneNumber | query | no | string | Optional exact-match E.164 phone number filter. |
| Status | query | no | [SmsConsentStatus](https://devportal.demo.winkpg.io/docs/api/models/SmsConsentStatus.md) | Optional status filter (opted in / opted out). |
| MerchantId | query | no | string(uuid) | Caller-requested merchant scope. Honoured only when the caller holds  `SmsConsent.ViewAllMerchants`; otherwise the caller's own merchant is used. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

**`Status` values**

| Value | Description |
| --- | --- |
| `OptedIn` | The recipient has expressly consented to receive SMS from this merchant. Sends are allowed. |
| `OptedOut` | The recipient has revoked consent (STOP keyword, carrier unsubscribe, or an operator action). The send-time gate blocks every SMS to this number for this merchant until a re-opt-in is recorded. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`ContinuationPagedResultDtoOfSmsConsentDto`](https://devportal.demo.winkpg.io/docs/api/models/ContinuationPagedResultDtoOfSmsConsentDto.md)

Properties:
- `items` (array<[SmsConsentDto](https://devportal.demo.winkpg.io/docs/api/models/SmsConsentDto.md)>): The items returned for this page. (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `phoneNumber` (string): Canonical E.164 phone number this record governs. (nullable)
  - `tenantId` (string(uuid)): Tenant the record belongs to. (nullable)
  - `merchantId` (string(uuid)): Merchant the record is scoped to. (nullable)
  - `status` ([SmsConsentStatus](https://devportal.demo.winkpg.io/docs/api/models/SmsConsentStatus.md)): Current consent state.
    Values:
    - `OptedIn`: The recipient has expressly consented to receive SMS from this merchant. Sends are allowed.
    - `OptedOut`: The recipient has revoked consent (STOP keyword, carrier unsubscribe, or an operator action). The send-time gate blocks every SMS to this number for this merchant until a re-opt-in is recorded.
  - `captureMethod` ([SmsConsentCaptureMethod](https://devportal.demo.winkpg.io/docs/api/models/SmsConsentCaptureMethod.md)): How the most recent transition's evidence was captured.
    Values:
    - `Unknown`: Capture method was not supplied. Treated as the least-authoritative evidence.
    - `WebForm`: Recipient opted in through a public web form (e.g. a hosted checkout consent checkbox).
    - `VirtualTerminal`: An operator captured consent while taking the payment in the Virtual Terminal.
    - `HostedPaymentPage`: Consent was captured on a Hosted Payment Page flow.
    - `Import`: The record was created from a bulk import of prior consent evidence.
    - `ApiRequest`: Consent or opt-out was recorded through the API by an integrating system.
    - `AdminEntry`: An administrator recorded the consent or opt-out manually.
    - `CarrierBackfill`: Opt-out was back-filled from a carrier send-time signal (Twilio error 21610 on send). The platform learned of the revocation from the carrier rather than capturing it directly. Inbound STOP / START replies use InboundKeyword instead, which keeps a more precise evidence trail.
    - `InboundKeyword`: Consent transition was captured from an inbound SMS keyword the recipient texted to the platform number (STOP / UNSUBSCRIBE / START / etc.), received on the Twilio inbound webhook. The inbound message SID is retained as the evidence reference.
  - `statusChangedAt` (string(date-time)): When the current status was last set (UTC).
  - `evidenceText` (string): Proof-of-consent evidence for the current status. (nullable)
  - `evidenceReference` (string): Stable reference for the current status's source. (nullable)
  - `history` (array<[SmsConsentHistoryEntryDto](https://devportal.demo.winkpg.io/docs/api/models/SmsConsentHistoryEntryDto.md)>): Append-only audit trail of every status transition, oldest first. (nullable)
- `nextContinuationToken` (string): Continuation token to use when requesting the next page.  Null means no additional pages exist. (nullable)
- `approxTotalCount` (integer(int64)): An approximate total count of matching items.  This value is optional and may be stale or estimated, so treat it as an approximation. (nullable)
- `pageItemCount` (integer(int32)): Convenience property for the number of items in this page. (read only)
- `retrievedAt` (string(date-time)): When the page was retrieved. Useful for diagnostics and cache behavior.

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## 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.

### cURL

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

### PowerShell

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

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

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

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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)

```csharp
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();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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()
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.