Profile object | Middesk

This page describes the profile object, which represents a business’s social media or third-party platform profile. Profiles are derived from websites or matched from web presence analysis. Possible profile types include Google Places, Facebook Pages, LinkedIn Profiles, Instagram Pages, and Yelp Pages.

Retrieve profiles for a business

You can retrieve the profiles associated with a business using the Retrieve a business endpoint. Profiles are included in the business response.

$ curl https://api.middesk.com/v1/businesses/{business_id} \
>   -u {API_KEY}:

Example JSON response

1 [
2   {
3     "object": "profile",
4     "id": "efbae2ce-bbe9-416b-bee4-e17f2547dbc0",
5     "type": "facebook",
6     "external_id": "asocialprofile",
7     "url": "https://www.facebook.com/asocialprofile",
8     "status": "online",
9     "submitted": false,
10     "error": null,
11     "metadata": {
12       "name": "Example Business",
13       "rating": 4.5,
14       "rating_count": 120,
15       "followers": 5000
16     }
17   }
18 ]

Profile attributes

Attribute	Type	Description
`object`	string	The object type. Always `profile`.
`id`	string (uuid)	The unique identifier for the profile record.
`type`	string	Type of profile. Valid values are `facebook`, `google`, `instagram`, `yelp`, and `linkedin`.
`external_id`	string	Third-party identifier for the profile.
`url`	string	Canonical URL for the profile.
`status`	string	Status of the profile. Valid values are `online`, `offline`, and `unknown`.
`submitted`	boolean	Indicates whether the profile was submitted by the user (`true`) or discovered by Middesk (`false`).
`error`	string \| null	Error message if there were issues fetching or processing the profile.
`metadata`	object	Additional metadata sourced from the profile. See Metadata structure for details.

Profile status values

Status	Description
`online`	The profile is accessible and responding normally.
`offline`	The profile could not be reached or is not responding.
`unknown`	The profile status could not be determined.

Metadata structure

The metadata object contains profile-specific information that varies by profile type. Below are the common fields you may encounter:

Google Places metadata

Attribute	Type	Description
`name`	string	Business name.
`formatted_address`	string	Full address.
`formatted_phone_number`	string	Phone number.
`website`	string	Website URL.
`geometry.location`	object	Geographic coordinates with `lat` and `lng` properties.
`types`	array	Array of business categories.
`price_range`	string	Price level indicator.
`rating`	number	Average rating.
`user_ratings_total`	number	Total number of ratings.
`reviews`	array	Array of review objects with `author_name`, `author_url`, `rating`, `text`, and `time`.
`engagement_metrics`	object	Engagement statistics (if available).

Facebook metadata

Attribute	Type	Description
`name`	string	Page name.
`location`	object	Object with `city`, `state`, `latitude`, and `longitude` properties.
`category_list`	array	Array of page categories.
`rating`	number	Average rating.
`rating_count`	number	Number of ratings.
`followers`	number	Follower count.
`likes`	number	Page likes.
`were_here`	number	Check-in count.
`posts`	array	Array of recent post objects.
`reviews`	array	Array of review objects.
`engagement_metrics`	object	Engagement statistics (if available).

Yelp metadata

Attribute	Type	Description
`name`	string	Business name.
`price_range`	string	Price level indicator.
`is_closed`	boolean	Whether the business is closed.
`is_claimed`	boolean	Whether the business owner has claimed the listing.
`rating`	number	Average rating.
`rating_count`	number	Number of reviews.
`reviews`	array	Array of review objects.
`engagement_metrics`	object	Engagement statistics (if available).

LinkedIn and Instagram metadata

Metadata structure varies based on the profile type and available information.

Get a demo

Contact your account manager or contact sales to inquire about access.