For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
        • POSTCreate brand
        • GETGet brand
        • GETList brands
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
MessagingCampaign RegistryBrands

List brands

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands
GET
/api/relay/rest/registry/beta/brands
$curl https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/brands \
>     -u "<project_id>:<api_token>"
1{
2  "links": {
3    "self": "string",
4    "first": "string",
5    "next": "string",
6    "prev": "string"
7  },
8  "data": [
9    {
10      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11      "state": "pending",
12      "name": "My Brand",
13      "company_name": "BrandCo",
14      "contact_email": "brand_info@example.com",
15      "contact_phone": "+18995551212",
16      "ein_issuing_country": "United States",
17      "legal_entity_type": "Private Company",
18      "ein": "12-3456789",
19      "company_address": "123 Brand St, Hill Valley CA, 91905",
20      "company_vertical": "Healthcare",
21      "company_website": "www.example.com",
22      "csp_brand_reference": "string",
23      "csp_self_registered": false,
24      "status_callback_url": "https://example.com/handle_callback",
25      "created_at": "2024-01-15T09:30:00Z",
26      "updated_at": "2024-01-15T09:30:00Z"
27    }
28  ]
29}

Returns a list of your registered brands for 10DLC.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Was this page helpful?
Previous

Create campaign

Next
Built with

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Query parameters

filter_namestringOptional
The name given to the brand. Will return all Brands containing this value as a substring.
filter_statestringOptional
The state of the brand in the registration process, such as pending or complete. Will return all Brands with this value.

Response

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of brands.

Errors

401
Unauthorized Error
500
Internal Server Error