Brands

List Brands

Changed on

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

get/10dlc/brand

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/10dlc/brand
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number to retrieve (1-based).

recordsPerPageinteger

number of records per page. maximum of 500

sort'assignedCampaignsCount' | '-assignedCampaignsCount' | 'brandId' | '-brandId' | 'createdAt' | '-createdAt' | 'displayName' | '-displayName' | 'identityStatus' | '-identityStatus' | 'status' | '-status' | 'tcrBrandId' | '-tcrBrandId'

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

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

displayNamestring

Filter results by display name.

entityTypestring

Filter results by entity type.

statestring

Filter results by state.

countrystring

Filter results by country.

brandIdstring
Example:826ef77a-348c-445b-81a5-a9b13c68fbfe

Filter results by the Telnyx Brand id

tcrBrandIdstring
Example:BBAND1

Filter results by the TCR Brand id

Response

Successful Response

pageinteger
totalRecordsinteger

Example response

{
  "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
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status