Skip to main content
This API lets you fetch all profiles created by your account.

​
API Endpoint

GET
https://api.plivo.com/v1/Account/{auth_id}/Profile/

​
Arguments

limit
integer

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.

entity_type
string

Filter by entity_type.

Allowed values: PRIVATE, PUBLIC, NON_PROFIT, GOVERNMENT, INDIVIDUAL.

type
string

Filter by profile_type.

Allowed values: PRIMARY, SECONDARY.

vertical
string

Filter by vertical.

Allowed values: PROFESSIONAL, REAL_ESTATE, HEALTHCARE, HUMAN_RESOURCES, ENERGY, ENTERTAINMENT, RETAIL, TRANSPORTATION, AGRICULTURE, INSURANCE, POSTAL, EDUCATION, HOSPITALITY, FINANCIAL, POLITICAL, GAMBLING, LEGAL, CONSTRUCTION, NGO, MANUFACTURING, GOVERNMENT, TECHNOLOGY, COMMUNICATION.

​
Returns

api_id for the request and a dictionary with an objects property that contains a list of up to 20 profiles. Each tuple in the list is a separate profile object. 
import sys
sys.path.append("../plivo-python")
import plivo

client = plivo.RestClient("<auth_id>", "<auth_token>")
param = {"company_name": "google", "website": "www.example.com"}
response = client.profile.update("<profile_uuid>", param)
print(response)

{
   "api_id":"837b1e38-68a1-4fd6-a532-ea4jj888uuhh",
   "meta":{
      "limit":1,
      "offset":0,
      "next":"/v1/Account/<AUTH_ID>/Profile/?limit=1&offset=1",
      "previous":null
   },
   "profiles":[
      {
         "profile_uuid":"7a799f1a-5f44-43fb-ac82-999uujnnhhy",
         "profile_alias":"sample name",
         "profile_type":"SECONDARY",
         "primary_profile":"a7fe9aa3-dbca-401e-80a2-f88dudhdbhd",
         "customer_type":"DIRECT",
         "entity_type":"PRIVATE_PROFIT",
         "company_name":"Name of Company",
         "ein":"111111111",
         "ein_issuing_country":"US",
         "address":{
            "street":"5d807cf24ada0f",
            "city":"New York",
            "state":"NY",
            "postal_code":"10001",
            "country":"US"
         },
         "website":"www.example.com",
         "vertical":"COMMUNICATION",
         "plivo_subaccount": "SAXXXXX",
         "stock_symbol": "NSQ",
         "stock_exchange": "NASDAQ",
         "alt_business_id": "ABC",
         "alt_business_id_type": "DUNS",
         "authorized_contact":{
            "first_name":"First Name",
            "last_name":"Last Name",
            "phone":"919033998877",
            "email":"xxxxxxxx@plivo.com",
            "title":"Manager",
            "seniority":"Mr."
         },
         "created_at":"2023-10-17T20:57:54.164054Z"
      }
   ]
}