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