List Brands

GET 
/brand

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

Query Parameters

page Page

Possible values: >= 1

Default value: 1

recordsPerPage Recordsperpage

Default value: 10

number of records per page. maximum of 500

sort Sort
Possible values: [assignedCampaignsCount, -assignedCampaignsCount, brandId, -brandId, createdAt, -createdAt, displayName, -displayName, identityStatus, -identityStatus, status, -status, tcrBrandId, -tcrBrandId]
Default value: -createdAt
Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.
Example: -identityStatus
displayName Displayname
entityType Entitytype
state State
country Country
brandId BrandId

Filter results by the Telnyx Brand id

tcrBrandId TCRBrandId

Filter results by the TCR Brand id

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

records

object[]

Array [

brandId string

Unique identifier assigned to the brand.

tcrBrandId string

Unique identifier assigned to the brand by the registry.

entityType EntityType

Possible values: [PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT]

Entity type behind the brand. This is the form of business establishment.

identityStatus BrandIdentityStatus

Possible values: [VERIFIED, UNVERIFIED, SELF_DECLARED, VETTED_VERIFIED]

The verification status of an active brand

companyName string

(Required for Non-profit/private/public) Legal company name.

displayName string

Display or marketing name of the brand.

email string

Valid email address of brand support contact.

website string

Brand website URL.

failureReasons failureReasons

Failure reasons for brand

status status

Possible values: [OK, REGISTRATION_PENDING, REGISTRATION_FAILED]

Status of the brand

createdAt string

Date and time that the brand was created at.

updatedAt string

Date and time that the brand was last updated at.

assignedCampaingsCount integer

Number of campaigns associated with the brand

]

page Page (integer)
totalRecords Totalrecords (integer)

{
  "records": [
    {
      "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
      "tcrBrandId": "BBRAND1",
      "entityType": "PRIVATE_PROFIT",
      "companyName": "Example Company Inc.",
      "displayName": "Example Company",
      "email": "examplename@examplecompany.com",
      "website": "www.examplecompany.com",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186",
      "assignedCampaingsCount": 2
    }
  ],
  "page": 1,
  "totalRecords": 1
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/10dlc/brand' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "records": [
    {
      "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
      "tcrBrandId": "BBRAND1",
      "entityType": "PRIVATE_PROFIT",
      "companyName": "Example Company Inc.",
      "displayName": "Example Company",
      "email": "examplename@examplecompany.com",
      "website": "www.examplecompany.com",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186",
      "assignedCampaingsCount": 2
    }
  ],
  "page": 1,
  "totalRecords": 1
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}