Retrieve a profile

GET/social/{connection_id}/profile/{id}

Parameters

Returns

Response field	Type	Required	Description
`id`	string	No	Unique identifier for the profile
`created_at`	string (date-time)	No	When the profile was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	When the profile was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	Display name of the profile
`username`	string	No	Handle/username/store code
`parent_id`	string	No	Parent profile id when profiles are nested (e.g. account → location)
`description`	string	No	Bio or description of the profile
`url`	string	No	Public URL of the profile
`website_url`	string	No	External website linked from the profile
`avatar_url`	string	No	Profile image URL
`phone`	string	No	Contact phone number
`location`	string	No	Free-text location/locale string
`address`	object	No	Structured postal address
`address.address1`	string	No
`address.address2`	string	No
`address.city`	string	No
`address.region`	string	No
`address.postal_code`	string	No
`address.country`	string	No
`category`	string	No	Primary category of the profile
`is_verified`	boolean	No	Whether the profile is verified
`is_private`	boolean	No	Whether the profile is private/protected
`metrics`	object	No	Audience metrics for the profile
`metrics.follower_count`	number	No	Number of followers
`metrics.following_count`	number	No	Number of accounts this profile follows
`metrics.post_count`	number	No	Total number of posts published by this profile

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'GET',
  url: 'https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.social.getSocialProfile({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/social/5de520f96e439b002043d8dc/profile/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?