REST ClientRegistryBrands

list

View as MarkdownOpen in Claude

List registered 10DLC brands.

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

datalist of objectsOptional
List of brands.

Response Example

Response
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}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9brands = client.registry.brands.list()
10for brand in brands.get("data", []):
11    print(brand.get("display_name"), brand.get("entity_type"))