# GET /api/twilio/sms-log/by-correlation/{correlationId}

SMS Log: gets the delivery record for one outbound message by its correlation id.

This is the lookup a sending feature uses to reflect a delivery outcome on its own record: it holds
the correlation id returned by the send, and asks here whether the message was delivered, blocked
by the compliance gate, or failed at the carrier. The tenant and merchant ids must match the
message's owning scope, and the caller's own scope is enforced on top. Returns no content when no
record exists, which includes a message whose row has aged out of the 30-day retention window.

**Operation ID:** `smsLogFindByCorrelationId`

## Authorization

Requires: Twilio.SmsLog.View, merchant scope.

Required permissions:
- `Twilio.SmsLog.View`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| correlationId | path | yes | string(uuid) | Correlation id returned by the send. |
| tenantId | query | no | string(uuid) | Tenant id that scopes the lookup. |
| merchantId | query | no | string(uuid) | Merchant id that scopes the lookup. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

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

Schema: `SmsLogDto`

Properties:
- `id` (string(uuid))
- `correlationId` (string(uuid)): The platform correlation id for this message. Equal to `id`: there is  exactly one row per outbound message, so the correlation id is the document key. Surfaced under  its own name because that is what callers of the send API hold.
- `toPhoneNumberMasked` (string): Recipient reduced to its last four digits (for example `•••••••4567`).
- `fromPhoneNumberMasked` (string): Sending number reduced to its last four digits, when the send used a from-number.
- `messagingServiceSid` (string): The Messaging Service SID the send routed through, when one was configured.
- `messageSid` (string): Twilio's message SID, once the API accepted the message. Null for blocked / failed sends.
- `status` (object): Where the message currently sits in its lifecycle.
- `isFailure` (boolean): Whether `status` means the message did not reach the handset.
- `twilioErrorCode` (integer(int32)): Twilio numeric error code from the failing send or callback, when one was reported.
- `failureCode` (string): Platform error code explaining a gateway-side refusal (for example a compliance block).
- `bodyLength` (integer(int32)): Message length in characters. The body itself is never stored or returned.
- `category` (object): Declared message category.
- `timestamp` (string(date-time)): When the send was attempted (UTC).
- `lastStatusAt` (string(date-time)): When the most recent carrier callback was applied (UTC). Null until the first one lands.
- `tenantId` (string(uuid)): Tenant the message was sent under.
- `merchantId` (string(uuid)): Merchant the message belongs to.

### 403

Forbidden

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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. See the error-code reference in this document's description for the values `error.code` can take.

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

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

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.
- `title` (string) required: A short, human-readable summary of the problem type.
- `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.
- `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`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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-log/by-correlation/{correlationId}" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}' `
    -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.smsLogFindByCorrelationId("3fa85f64-5717-4562-b3fc-2c963f66afa6");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/twilio/sms-log/by-correlation/{correlationId}', {
  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.SmsLogFindByCorrelationIdAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));
```

### C# (raw HTTP)

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

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/twilio/sms-log/by-correlation/{correlationId}");
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_log_find_by_correlation_id("3fa85f64-5717-4562-b3fc-2c963f66afa6")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

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

## See also

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