> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.chatbridge.mx/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.chatbridge.mx/_mcp/server.

# List available masks

GET https://connect.chatbridge.mx/v1/sms/masks

Retrieves the masks (senders) enabled for the account of the authenticated API Key. The `id` field of each mask must be used as the value of the `mask` field when sending a message. If no masks are configured, an empty array is returned.

Reference: https://docs.chatbridge.mx/sms/masks/list-sms-masks

## Authentication

- `x-api-key` header (required) — Account authentication key. The App-Key must have the SMS channel enabled; it cannot be used against the endpoints of other channels.
- `Authorization` header (bearer token, required) — OAuth 2.0 access token issued by `POST /api/oauth/token` (client-credentials). Takes precedence over `x-api-key` when both are sent. See the Authentication section.

## Response

### 200

List of available masks.

- `list of Mask`

## Errors

### 401 Unauthorized Error

Authentication is missing or invalid.

- `message` (string, optional)
- `error` (string, optional)
- `statusCode` (integer, optional)
- `errorCode` (integer, optional)

### 403 Forbidden Error

The API Key does not have access to the SMS channel.

- `message` (string, optional)
- `error` (string, optional)
- `statusCode` (integer, optional)
- `errorCode` (integer, optional)

### 429 Too Many Requests Error

The requests-per-minute limit was exceeded.

- `message` (string, optional)
- `error` (string, optional)
- `statusCode` (integer, optional)
- `errorCode` (integer, optional)

## Types

### Mask

- `id` (string, optional) — Unique identifier of the mask. It is used in the `mask` field when sending a message.
- `type` (enum, optional) — Type of mask configured.
  - Allowed values: `LARGO`, `CORTO`, `OTP`
- `name` (string, optional) — Descriptive name of the mask.
- `is_international` (boolean, optional) — Indicates whether the mask is enabled for international sends.
- `operators` (list of enum, optional) — Operators with an output configured for the mask.
  - Allowed values: `telcel`, `movistar`, `att`, `other`

## Examples

**Response**

```json
[
  {
    "id": "6a4bffd5e77672e33fd5304f",
    "type": "OTP",
    "name": "ChatBridge",
    "is_international": false,
    "operators": [
      "telcel",
      "movistar",
      "att",
      "other"
    ]
  }
]
```

**SDK Code**

```python Masks_listSmsMasks_example
import requests

url = "https://connect.chatbridge.mx/v1/sms/masks"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Masks_listSmsMasks_example
const url = 'https://connect.chatbridge.mx/v1/sms/masks';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Masks_listSmsMasks_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.chatbridge.mx/v1/sms/masks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Masks_listSmsMasks_example
require 'uri'
require 'net/http'

url = URI("https://connect.chatbridge.mx/v1/sms/masks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java Masks_listSmsMasks_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://connect.chatbridge.mx/v1/sms/masks")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php Masks_listSmsMasks_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://connect.chatbridge.mx/v1/sms/masks', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Masks_listSmsMasks_example
using RestSharp;

var client = new RestClient("https://connect.chatbridge.mx/v1/sms/masks");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift Masks_listSmsMasks_example
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://connect.chatbridge.mx/v1/sms/masks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```