Brands
List Brands
This endpoint is used to list all brands associated with your organization.
get/10dlc/brand
Query parameters
pageinteger
Page number to retrieve (1-based).
recordsPerPageinteger
number of records per page. maximum of 500
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
Example response
{
"page": 1,
"records": [
{
"assignedCampaingsCount": 2,
"brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
"companyName": "Example Company Inc.",
"createdAt": "2021-03-08T17:57:48.801186",
"displayName": "Example Company",
"email": "examplename@examplecompany.com",
"entityType": "PRIVATE_PROFIT",
"tcrBrandId": "BBRAND1",
"updatedAt": "2021-03-08T17:57:48.801186",
"website": "www.examplecompany.com"
}
],
"totalRecords": 1
}