> ## Documentation Index
> Fetch the complete documentation index at: https://plivo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve all profiles

> List all business profiles created under your account

This API lets you fetch all profiles created by your account.

#### API Endpoint

```text GET theme={null}
https://api.plivo.com/v1/Account/{auth_id}/Profile/
```

### Arguments

<table>
  <tbody>
    <tr>
      <td><strong>limit<br />integer</strong></td>

      <td>
        <p>Denotes the number of results per page. The maximum number of results that can be fetched is 20.</p>
        <p>Defaults to 20.</p>
      </td>
    </tr>

    <tr>
      <td><strong>offset<br />integer</strong></td>

      <td>
        <p>Denotes the number of value items by which the results should be offset. Defaults to 0. Read more about <a href="https://docs.plivo.com/docs/messaging/api/request/pagination">offset-based pagination</a>.</p>
      </td>
    </tr>

    <tr>
      <td><strong>entity\_type<br />string</strong></td>

      <td>
        <p>Filter by entity\_type.</p>
        <p>Allowed values: PRIVATE, PUBLIC, NON\_PROFIT, GOVERNMENT, INDIVIDUAL.</p>
      </td>
    </tr>

    <tr>
      <td><strong>type<br />string</strong></td>

      <td>
        <p>Filter by profile\_type.</p>
        <p>Allowed values: PRIMARY, SECONDARY.</p>
      </td>
    </tr>

    <tr>
      <td><strong>vertical<br />string</strong></td>

      <td>
        <p>Filter by vertical.</p>
        <p>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.</p>
      </td>
    </tr>
  </tbody>
</table>

### 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.

<RequestExample>
  ```py Python theme={null}
  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)
  ```

  ```ruby Ruby theme={null}
  require "rubygems"
  require "/etc/plivo-ruby/lib/plivo.rb"
  include Plivo

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

  begin
  	# Update Profile
  	puts('Update Profile')
  	response=api.profile.update("<profile_uuid>", 
  		company_name: "Name of Company",
  	    website: "www.plivo.com");

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

  ```js Node theme={null}
  let plivo = require('plivo');

  var params = { "company_name": "twitter.com" }
  var client = new plivo.Client("<auth_id>", "<auth_token>");
  client.profile.update("<profile_uuid>", params)
      .then(function (response) {
          console.log(response);
      })
      .catch(function (error) {
          console.log(error);
      });
  ```

  ```php PHP theme={null}
  <?php

  require '/etc/plivo-php/vendor/autoload.php';
  use Plivo\RestClient;
  $client = new RestClient("<auth_id>", "<auth_token>");
  $address = array(
      "street" => "123",
      "city" => "Band",
      "state" => "NY",
      "postal_code" => "10008",
      "country" => "US"
  );

  $client
      ->client
      ->setTimeout(60);
  try
  {
      $res = $client
          ->profile
          ->update("<profile_uuid>", ['address' => $address, 'vertical' => "PROFESSIONAL"]);
      print_r($res);
  }
  catch(PlivoRestException $ex)
  {
      print_r($ex);
  }

  ?>
  ```

  ```java Java theme={null}
  package com.plivo.examples;

  import com.plivo.api.Plivo;
  import com.plivo.api.models.profile.Profile;

  public class PlivoTest {

      public static void main(String[] args) {

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

          // Update Profile
          try {
              Profile response = Profile.update("<Profile_UUID>")
                  .companyName("new company name")
                  .vertical("PROFESSIONAL")
                  .update();
              System.out.println(response);
          } catch (Exception e) {
              e.printStackTrace();
          }
      }
  }
  ```

  ```csharp .NET theme={null}
  // Available in versions >= 5.9.0 (https://github.com/plivo/plivo-dotnet/releases/tag/v5.9.0)

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

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

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

              // Update a Profile
              try
              {
                  AuthorizedContact contact = new AuthorizedContact();
                  contact.Email = "test@gmail.com";
                  Address address = new Address();
                  address.PostalCode = "560099";
                  var response = api.Profile.Update("f8ca5a50-50b8-438d-8068-28427b1c0e90", "Update Name");
                  Console.WriteLine(response);
              }
              catch (PlivoRestException e)
              {
                  Console.WriteLine("Exception: " + e.Message);
              }


          }
      }
  }
  ```

  ```go Go theme={null}
  package main

  import (
          "fmt"
          "os"

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

  var client *plivo.Client

  func initClient(authID, authToken string) {
          var er error
          copts := &plivo.ClientOptions{}
          client, er = plivo.NewClient(authID, authToken, copts)
          if er != nil {
                  panic(er)
          }
  }

  func main() {
          initClient("<auth_id>", "<auth_token>")
          //Update Profile
          input := plivo.UpdateProfileRequestParams{
                  Website: "www.google1.com",
                  EntityType: "PRIVATE",
                  Address: &plivo.Address{
                          Street:      "Street Name",
                          City:        "City Name",
                          State:       "NY",
                          PostalCode: "10001",
                          Country:     "US",
                  },
          }
          response, err := client.Profile.Update("<profile_uuid>", input)
          if err != nil {
                  fmt.Printf("Error occurred while updating profile. error:%+v\n", err)
                  os.Exit(1)
          } else {
                  fmt.Printf("%+v\n", response)
          }
  }
  ```

  ```sh cURL theme={null}
  curl -i --user auth_id:auth_token \
      -H 'Content-Type: application/json' \
      -d '{
          "vertical":"ENTERTAINMENT"    
      }' \
      https://api.plivo.com/v1/Account/{auth_id}/Profile/{profile_uuid}/
  ```
</RequestExample>

### Response

```json theme={null}
{
   "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"
      }
   ]
}
```
