Profile object

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 Google profile

1 {
2   "object": "profile",
3   "type": "google",
4   "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
5   "external_id": "10000000000000000001",
6   "url": "https://maps.google.com/?cid=10000000000000000001",
7   "metadata": {
8     "full_address": "123 Main St Suite 100, San Francisco, CA 94105",
9     "name": "Acme Manufacturing",
10     "website_urls": ["https://www.acmemanufacturing.com/"],
11     "latitude": 37.78827,
12     "longitude": -122.39997,
13     "phone_number": "(415) 555-0100",
14     "categories": ["Machine shop"],
15     "reviews": [
16       {
17         "rating": 5,
18         "posted_at": "2024-03-15T14:30:00.000Z"
19       }
20     ]
21   },
22   "rating": 5,
23   "rating_count": 1
24 }

Example Facebook profile

1 {
2   "object": "profile",
3   "type": "facebook",
4   "id": "b2c3d4e5-6789-01ab-cdef-2345678901ab",
5   "external_id": null,
6   "url": "https://facebook.com/acme-manufacturing",
7   "metadata": {
8     "city": "San Francisco",
9     "state": "CA",
10     "name": "Acme Manufacturing",
11     "recent_posts": [],
12     "recent_reviews": []
13   },
14   "rating": null,
15   "rating_count": null
16 }

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 \| null	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.
`rating`	number \| null	Aggregate rating from the profile platform.
`rating_count`	number \| null	Total number of ratings on the profile.

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.
`full_address`	string	Full formatted address.
`phone_number`	string	Phone number.
`website_urls`	string[]	Website URLs associated with the business.
`latitude`	number	Geographic latitude.
`longitude`	number	Geographic longitude.
`categories`	string[]	Array of business categories.
`reviews`	object[]	Array of review objects with `rating` and `posted_at`.

Facebook metadata

Attribute	Type	Description
`name`	string	Page name.
`city`	string	City from the page’s location.
`state`	string	State from the page’s location.
`recent_posts`	object[]	Array of recent post objects.
`recent_reviews`	object[]	Array of recent review objects.

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.
`reviews`	object[]	Array of review objects.

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.