> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# list

> List registered 10DLC brands.

List registered 10DLC brands.

### Schema

```yaml
openapi: 3.1.0
info:
  title: API
  version: 1.0.0
paths:
  /api/relay/rest/registry/beta/brands:
    get:
      operationId: list_brands
      summary: List brands
      description: >-
        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: _Messaging_ and _Numbers_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_campaignRegistryBrands
      parameters:
        - name: filter_name
          in: query
          description: >-
            The name given to the brand. Will return all Brands containing this
            value as a substring.
          required: false
          schema:
            type: string
        - name: filter_state
          in: query
          description: >-
            The state of the brand in the registration process, such as pending
            or complete. Will return all Brands with this value.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://%7BYour_Space_Name%7D.signalwire.com
    description: SignalWire API
components:
  schemas:
    PaginationLinks:
      type: object
      properties:
        self:
          type: string
          description: Link to the current page.
        first:
          type: string
          description: Link to the first page.
        next:
          type: string
          description: Link to the next page. Only present when there are more results.
        prev:
          type: string
          description: Link to the previous page. Only present when not on the first page.
      required:
        - self
        - first
      description: Pagination links for list responses.
      title: PaginationLinks
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    Brand:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the brand.
        state:
          type: string
          description: The current state of the brand.
        name:
          type: string
          description: Brand/Marketing/DBA name of the business if applicable.
        company_name:
          type: string
          description: The legal name of the business.
        contact_email:
          type: string
          description: A company contact email for this brand.
        contact_phone:
          type: string
          description: A contact phone number for this brand.
        ein_issuing_country:
          type: string
          description: Country of registration.
        legal_entity_type:
          type: string
          description: >-
            What type of legal entity is the organization? (PRIVATE_PROFIT,
            PUBLIC_PROFIT, NON_PROFIT)
        ein:
          type: string
          description: Company EIN Number/Tax ID.
        company_address:
          type: string
          description: Full company address.
        company_vertical:
          type: string
          description: >-
            An optional Vertical for the brand (REAL_ESTATE, HEALTHCARE, ENERGY,
            ENTERTAINMENT, RETAIL, AGRICULTURE, INSURANCE, EDUCATION,
            HOSPITALITY, FINANCIAL, GAMBLING, CONSTRUCTION, NGO, MANUFACTURING,
            GOVERNMENT, TECHNOLOGY, COMMUNICATION).
        company_website:
          type: string
          description: Link to the company website.
        csp_brand_reference:
          type: string
          description: >-
            If you are your own Campaign Service Provider, this is the approved
            Brand ID (Mandatory for CSPs, otherwise please omit).
        csp_self_registered:
          type: boolean
          description: This value must be true for all self-registered brands.
        status_callback_url:
          type: string
          description: >-
            Optional: Specify a URL to receive webhook notifications when your
            brand's state changes. See the [10DLC status
            callback](/docs/apis/rest/campaign-registry/webhooks/ten-dlc-status-callback)
            docs for the webhook payload.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the brand was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the brand was last updated.
      required:
        - id
      description: Brand model for 10DLC registration.
      title: Brand
    BrandListResponse:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/PaginationLinks'
          description: Pagination links.
        data:
          type: array
          items:
            $ref: '#/components/schemas/Brand'
          description: List of brands.
      description: Response containing a list of brands.
      title: BrandListResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500

```

## **Response Example**

### Response (200)

```json
{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "state": "pending",
      "name": "My Brand",
      "company_name": "BrandCo",
      "contact_email": "brand_info@example.com",
      "contact_phone": "+18995551212",
      "ein_issuing_country": "United States",
      "legal_entity_type": "Private Company",
      "ein": "12-3456789",
      "company_address": "123 Brand St, Hill Valley CA, 91905",
      "company_vertical": "Healthcare",
      "company_website": "www.example.com",
      "csp_brand_reference": "string",
      "csp_self_registered": false,
      "status_callback_url": "https://example.com/handle_callback",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ]
}
```

## **Example**

```typescript {9}
import { RestClient } from "@signalwire/sdk";

const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});

const brands = await client.registry.brands.list();
for (const brand of brands.data ?? []) {
    console.log(brand.display_name, brand.entity_type);
}
```