social
profile

Retrieve a profile

get/social/{connection_id}/profile/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/social/{connection_id}/profile/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Profile

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the profile

created_atstring date-time

When the profile was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the profile was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Display name of the profile

usernamestring

Handle/username/store code

parent_idstring

Parent profile id when profiles are nested (e.g. account → location)

descriptionstring

Bio or description of the profile

urlstring

Public URL of the profile

website_urlstring

External website linked from the profile

avatar_urlstring

Profile image URL

phonestring

Contact phone number

locationstring

Free-text location/locale string

categorystring

Primary category of the profile

is_verifiedboolean

Whether the profile is verified

is_privateboolean

Whether the profile is private/protected

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.