Latest Legacy

Retrieve all brands

This API lets you fetch all the brands associated with an account.

API Endpoint

GET https://api.plivo.com/v1/Account/{auth_id}/10dlc/Brand/

Arguments

limitinteger

Denotes the number of results per page. The maximum number of results that can be fetched is 20.

Defaults to 20.
offset integer

Denotes the number of value items by which the results should be offset. Defaults to 0. Read more about offset-based pagination.
registration_statusstring

Filter by registration_status.

Allowed values: FAILED, PROCESSING, COMPLETED
typestring

Filter by registration type.

Allowed values: STARTER, STANDARD

Returns

api_id and a dictionary with an objects property that contains up to 20 brands. Each tuple in the list is a separate Brand object.

Response

HTTP Status Code: 200

{
   "api_id": "d1386e6e-bb29-11ec-bb91-0242ac110003",
   "brands": [
       {
           "address": {
               "city": "New York",
               "country": "US",
               "postal_code": "10001",
               "state": "NY",
               "street": "123"
           },
           "authorized_contact": {
               "email": "john@example.com",
               "first_name": "John",
               "last_name": "Doe",
               "phone": "+12125557777",
               "seniority": "admin",
               "title": "Doe"
           },
           "brand_alias": "john_sample_1",
           "brand_id": "BCDEF1G",
           "brand_type": "STANDARD",
           "company_name": "ABC Inc.",
           "ein": "111111111",
           "ein_issuing_country": "US",
           "entity_type": "PRIVATE_PROFIT",
           "profile_uuid": "09849948-656a-41a2-99da-8370251c804b",
           "registration_status": "COMPLETED",
           "vertical": "ENERGY",
           "vetting_score": 80,
           "vetting_status": "ACTIVE"
       },
       {
           "address": {
               "city": "",
               "country": "",
               "postal_code": "",
               "state": "",
               "street": ""
           },
           "authorized_contact": {},
           "brand_alias": "ABC Inc.",
           "brand_id": "BCDEF2G",
           "brand_type": "STANDARD",
           "company_name": "ABC Inc.",
           "ein": "111111111",
           "ein_issuing_country": "US",
           "entity_type": "PUBLIC",
           "registration_status": "COMPLETED",
           "vertical": "RETAIL",
           "vetting_score": 80,
           "vetting_status": "ACTIVE",
           "website": "https://www.abcmobile.com"
       },
       {
           "address": {
               "city": "New York",
               "country": "US",
               "postal_code": "10001",
               "state": "NY",
               "street": "123"
           },
           "authorized_contact": {
               "email": "edith@example.com",
               "first_name": "Edith",
               "last_name": "Sam",
               "phone": "+12125557778",
               "seniority": "admin",
               "title": "Sam"
           },
           "brand_alias": "sole_prop_007",
           "brand_id": "BCDEF3G",
           "brand_type": "STARTER",
           "ein_issuing_country": "US",
           "entity_type": "INDIVIDUAL",
           "profile_uuid": "55515d72-2852-4016-9ed9-c64bd1c0c055",
           "registration_status": "COMPLETED",
           "vertical": "ENERGY"
       },
       {
           "address": {
               "city": "",
               "country": "",
               "postal_code": "",
               "state": "",
               "street": ""
           },
           "authorized_contact": {},
           "brand_alias": "ren_sp_01",
           "brand_id": "B6AEUWW",
           "brand_type": "STARTER",
           "ein_issuing_country": "IN",
           "entity_type": "INDIVIDUAL",
           "profile_uuid": "3db43f63-270f-4d55-a591-27f7dc19b8e7",
           "registration_status": "COMPLETED",
           "vertical": "PROFESSIONAL"
       },
       {
           "address": {
               "city": "",
               "country": "",
               "postal_code": "",
               "state": "",
               "street": ""
           },
           "authorized_contact": {},
           "brand_alias": "something",
           "brand_id": "BCDEF4G",
           "brand_type": "STANDARD",
           "company_name": "ABC Inc.",
           "ein": "111111111",
           "ein_issuing_country": "US",
           "entity_type": "PRIVATE_PROFIT",
           "profile_uuid": "0ac18ad2-5086-4bde-84e5-275a2782cb40",
           "registration_status": "COMPLETED",
           "vertical": "PROFESSIONAL",
           "vetting_score": 80,
           "vetting_status": "ACTIVE"
       }
   ],
   "meta": {
       "limit": 5,
       "next": "/v1/Account/MAODZKMDFJMJU3MTEYNG/10dlc/Brand/?limit=5&offset=10",
       "offset": 5,
       "previous": "/v1/Account/MAODZKMDFJMJU3MTEYNG/10dlc/Brand/?limit=5&offset=0"
   }
}

Example Request 

1
2
3
4
5

import plivo

client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.list(limit=1, offset=0)
print(response)

1
2
3
4
5
6
7
8
9
10
11
12
13

require "rubygems"
require "/etc/plivo-ruby/lib/plivo.rb"
include Plivo

api = RestClient.new("<auth_id>", "<auth_token>")

begin
response = api.brand.list(limit: 1, offset: 0)

puts response
rescue PlivoRESTError => e
    puts 'Exception: ' + e.message
end

1
2
3
4
5
6
7
8
9
10

let plivo = require('plivo');

let client = new plivo.Client("<auth_id>", "<auth_token>");
client.brand.list()
    .then(function (response) {
        console.log(JSON.stringify(response));
    }).catch(function (error) {
        console.log("err");
        console.log(error);
    });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

<?php

# Available in versions >= 4.29.0 (https://github.com/plivo/plivo-php/releases/tag/v4.29.0)

require '/etc/plivo-php/vendor/autoload.php';
use Plivo\RestClient;
$client = new RestClient("<auth_id>", "<auth_token>");
$client
    ->client
    ->setTimeout(60);
try
{
    $res = $client
        ->brand
        ->list();
    print_r($res);
}
catch(PlivoRestException $ex)
{
    print_r($ex);
}
?>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

package com.plivo.examples;

import com.plivo.api.Plivo;
import com.plivo.api.models.base.ListResponse;
import com.plivo.api.models.brand.Brand;

public class PlivoTest {

    public static void main(String[] args) {

        Plivo.init("<auth_id>", "<auth_token>");

        // List Brand
        try {
            ListResponse < Brand > response = Brand.lister().limit(1).offset(2).list();
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Exception;

namespace dotnet_project
{
    class Ten_dlc
    {
        static void Main(string[] args)
        {

            var api = new PlivoApi("<auth_id>", "<auth_token>");

            // List Brand
            Console.WriteLine("List Brand");
            try
            {
                var response = api.Brand.List();
                Console.WriteLine(response);
            }
            catch (PlivoRestException e)
            {
                Console.WriteLine("Exception: " + e.Message);
            }
        }
    }
}

1
2

curl -i --user auth_id:auth_token \
    https://api.plivo.com/v1/Account/{auth_id}/10dlc/Brand/  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

package main

import (
        "fmt"
        "os"

        plivo "github.com/plivo/plivo-go/v7"
)

func main() {
        client, err := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{})
        if err != nil {
                panic(err)
        }
        //List Brands
        response, err := client.Brand.List(plivo.BrandListParams{Limit: 1, Offset: 0})
        if err != nil {
                fmt.Printf("Error occurred while getting brands. error:%+v\n", err)
                os.Exit(1)
        } else {
                fmt.Printf("%+v\n", response)
        }
}