List Brands

This endpoint is used to list all brands associated with your organization.

GET /10dlc/brand

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const brandListResponse of client.messaging10dlc.brand.list()) {
  console.log(brandListResponse.identityStatus);
}

200

{
  "records": [
    {
      "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
      "tcrBrandId": "BBRAND1",
      "entityType": "PRIVATE_PROFIT",
      "identityStatus": "VERIFIED",
      "companyName": "Example Company Inc.",
      "displayName": "Example Company",
      "email": "[e-mail]",
      "website": "www.examplecompany.com",
      "failureReasons": "<string>",
      "status": "OK",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186",
      "assignedCampaingsCount": 2
    }
  ],
  "page": 1,
  "totalRecords": 1
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · integer · default: 1

Required range: x >= 1

recordsPerPage · integer · default: 10

number of records per page. maximum of 500

sort · enum<string> · default: -createdAt

Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Available options: assignedCampaignsCount, -assignedCampaignsCount, brandId, -brandId, createdAt, -createdAt, displayName, -displayName, identityStatus, -identityStatus, status, -status, tcrBrandId, -tcrBrandId

displayName · string

entityType · string

state · string

country · string

brandId · string

Filter results by the Telnyx Brand id

Example:

"826ef77a-348c-445b-81a5-a9b13c68fbfe"

tcrBrandId · string

Filter results by the TCR Brand id

Example:

"BBAND1"

Response

200

application/json

Successful Response

records · ListedBrand · object[]

Show child attributes

page · integer

Example:

1

totalRecords · integer

Example:

1