x-APIKey header — see the Overview for connection instructions.
Businesses
Search, retrieve, and update business listings managed in Partoo.search_businesses
Search for businesses with optional filters. Supports fuzzy matching across city, zip code, and business name.
Fuzzy search term matched against city, zip code, and business name.
Exact business name filter.
Filter by city.
Filter by postal code.
Filter by country. ISO 3166 alpha-2 code (e.g.
FR, GB).Filter by business status. One of:
open, closed, opening_soon, temporarily_closed.Filter by internal business code.
Filter by organisation ID. Available to
PROVIDER users only.Page number (1–100).
Results per page (1–100).
Field to sort by. Prefix with
- for descending order (e.g. -name).get_business
Fetch the full detail of a single business.
Business ID, or
c-{code} to look up by store code.update_business
Update one or more fields of an existing business. Only the fields you provide are changed.
Business ID, or
c-{code} to look up by store code.Business display name.
Internal store code.
Group IDs to assign to the business.
Category IDs. At least one must be provided if this field is set.
National business registration number.
One of:
open, closed, temporarily_closed.Planned opening date. Format:
YYYY-MM-DD.Street address line 1.
Street address line 2.
City.
Postal code.
Region or state.
ISO 3166 alpha-2 country code (e.g.
FR, GB).Latitude in decimal degrees.
Longitude in decimal degrees.
Business website URL.
Facebook page URL.
Twitter / X profile URL.
Short description. Maximum 80 characters.
Long description. Maximum 750 characters.
Regular opening hours. Provide all 7 days.
Exceptional opening periods (holidays, special events).
Contact entries (phone numbers, email addresses, etc.).
Photo assignments for the business profile.
Reviews
Search reviews, post replies, and retrieve review analytics.search_reviews
Search for customer reviews across one or more businesses with optional filters.
Comma-separated list of business IDs to filter by.
Comma-separated list of review platforms. Accepted values:
google_my_business, facebook, tripadvisor.Comma-separated list of review states. Accepted values:
treated, not_treated, deleted.Comma-separated keywords to search for in review content.
Return reviews updated on or after this date. ISO 8601 format.
Return reviews updated on or before this date. ISO 8601 format.
Set to
true to return only reviews without text content.Set to
true to return only untagged reviews.Page number (1–100).
Results per page (1–100).
Sort field. Accepted values:
update_date, -update_date.reply_to_review
Post a public reply to a customer review.
ID of the review to reply to.
Text content of the reply.
get_review_metrics
Retrieve aggregated review analytics such as average rating, rating distribution, reply rate, and trends.
Comma-separated list of metrics to retrieve. Accepted values:
average_rating, rating_distribution, reviews_count, reply_time, reply_means, rank.Comma-separated list of dimensions to group by. Accepted values:
day, week, month, year, business, group, tag.Comma-separated list of business IDs to filter by.
Start of the date range. ISO 8601 format.
End of the date range. ISO 8601 format.
Field to sort by. Prefix with
- for descending order.Page number.
Results per page.
Messages
List conversations and send messages through Partoo’s messaging platform.list_conversations
List messaging conversations, optionally filtered by business.
Comma-separated list of business IDs to filter by.
Results per page (1–100).
Pagination cursor returned by the previous response.
send_message
Send a text message in an existing conversation.
ID of the conversation to send the message to.
Text content of the message.
list_messages
List messages within a conversation.
ID of the conversation.
Results per page (1–100).
Pagination cursor returned by the previous response.
Posts
Create and search social posts published to Google, Facebook, and Instagram.create_post
Create and publish a post to one or more platforms. Supports news, events, and offers with optional CTAs and scheduling.
IDs of the businesses to publish the post for.
Platforms to publish to. Accepted values:
google_my_business, facebook, instagram.Type of post. One of:
news, event, offer.Main text content of the post.
Post title.
URL of the image to attach to the post.
Call-to-action button type. One of:
book, order, shop, learn_more, sign_up, call, no_cta.URL linked from the call-to-action button.
Post start date/time in ISO 8601 format. Uses the business’s local timezone.
Post end date/time in ISO 8601 format. Uses the business’s local timezone.
Set to
true to save as a draft instead of publishing immediately.search_posts
Search posts published across Google, Facebook, Instagram, and Store Locator.
Comma-separated list of business IDs to filter by.
Filter by a substring match on the post description.
Comma-separated list of post states. Accepted values:
live, to_configure, pending, scheduled, error, expired, to_validate.Filter by post type. One of:
standard, event, offer, alert.Return posts starting on or after this date/time. ISO 8601 format.
Return posts ending on or before this date/time. ISO 8601 format.
Page number (1–100).
Results per page (1–100).
Analytics
Query Google Business Profile metrics and search keyword data.get_profile_metrics
Retrieve Google Business Profile performance metrics such as impressions, direction requests, call clicks, and website clicks.
Comma-separated list of metrics to retrieve. Accepted values:
business_impressions_desktop_maps, business_impressions_desktop_search, business_impressions_mobile_maps, business_impressions_mobile_search, business_direction_requests, call_clicks, website_clicks.Comma-separated list of dimensions to group by. Accepted values:
business, day, week, month, year.Comma-separated list of business IDs to filter by.
Fuzzy search term matched against city, zip code, and business name.
Filter by city.
Start of the date range. ISO 8601 format.
End of the date range. ISO 8601 format.
Field to sort by. Prefix with
- for descending order.Page number.
Results per page (max 500).
get_profile_keywords
Retrieve Google search keywords that drove traffic to business profiles.
Comma-separated list of metrics to retrieve. Accepted values:
count, threshold.Comma-separated list of dimensions to group by. Accepted values:
business, keyword, month, year, branded.Comma-separated list of business IDs to filter by.
Set to
true to return only branded keywords, false for discovery keywords only.Start of the date range. ISO 8601 format.
End of the date range. ISO 8601 format.
Field to sort by. Prefix with
- for descending order.Page number.
Results per page (max 500).