This API lets you fetch all profiles created by your account.
GET
https://api.plivo.com/v1/Account/{auth_id}/Profile/
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. |
entity_typestring |
Filter by entity_type. Allowed values: PRIVATE, PUBLIC, NON_PROFIT, GOVERNMENT, INDIVIDUAL. |
typestring |
Filter by profile_type. Allowed values: PRIMARY, SECONDARY. |
verticalstring |
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. |
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.
HTTP Status Code: 200
{
"api_id": "bb97cf86-baf3-11ec-a55b-0242ac110005",
"meta": {
"limit": 1,
"next": "/v1/Account/MAYTYWOTQXNWM3MGRMNG/Profile/?limit=1&offset=1",
"offset": 0
},
"profiles": [
{
"address": {
"city": "New York",
"country": "US",
"postal_code": "10001",
"state": "NY",
"street": "123"
},
"authorized_contact": {
"email": "johh@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+12125557777",
"seniority": "admin",
"title": "Doe"
},
"company_name": "ABC Inc.",
"customer_type": "DIRECT",
"entity_type": "INDIVIDUAL",
"primary_profile": "c780f9d0-e3c9-4d13-87f7-b898654569b0",
"profile_alias": "john_doe",
"profile_type": "SECONDARY",
"profile_uuid": "6dc1228e-70dd-4370-9379-b232fdb5f2cb",
"vertical": "ENERGY"
}
]
}
1
2
3
4
5
import plivo
client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.profile.list(limit=1, offset=0)
print(response)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
require "rubygems"
require "/etc/plivo-ruby/lib/plivo.rb"
include Plivo
api = RestClient.new("<auth_id>", "<auth_token>")
begin
# List all Profiles
response = api.profile.list(limit: 10, offset: 0)
puts response
rescue PlivoRESTError => e
puts 'Exception: ' + e.message
end
1
2
3
4
5
6
7
8
9
10
11
12
13
let plivo = require('plivo');
var client = new plivo.Client("<auth_id>", "<auth_token>");
client.profile.list({
limit: 5,
offset: 0,
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?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->profile->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.profile.Profile;
import com.plivo.api.models.base.ListResponse;
public class PlivoTest {
public static void main(String[] args) {
Plivo.init("<auth_id>", "<auth_token>");
// List all Profiles
try {
ListResponse < Profile > response = Profile.lister().limit(1).offset(0).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
29
30
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>");
// List Profiles
try
{
var response = api.Profile.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}/Profile/
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 Profiles
response, err := client.Profile.List(plivo.ProfileListParams{Limit: 2, Offset: 0})
if err != nil {
fmt.Printf("Error occurred while getting profiles error:%+v\n", err)
os.Exit(1)
} else {
fmt.Printf("%+v\n", response)
}
}