v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Review Booster

Search for an invitation matching a set of criteria

This endpoint allows to fetch previously sent invitations. Your access token must be for an user subscribed to the Review Booster product to access this route. The user must have access to the business. This can be useful to avoid sending multiple invitations to the same user in a defined period.

get/review_booster/search-invitation

Query parameters

business_idstring required

Business id

Example:5409c35a97bbc544d8e26737
target_phonestring required

the exact phone number we would have sent the invitation(s) to

Example:0701020304
afternumber
Example:1559148288

Response

OK

pageinteger

Current page number

max_pageinteger

Last page number

countinteger

Number of resources complying with filters

Example response

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "review_invitations": [
    {
      "user_name": "Perceval",
      "user_id": "54b6733b9826bf1dd29af128",
      "id": "3d90efec-0d7f-4960-98c0-951d58dc14cb",
      "sent_time": "2019-06-06 11:57:27.274725+00:00"
    }
  ]
}