Search invitations

GET 
/api/v2/reviews/invitations

Search invitations

Request

Query Parameters

after timestamp
target_phone stringrequired
The exact phone number we would have sent the invitation(s) to
Example: 0701020304
business_id stringrequired
Business id
Example: 5409c35a97bbc544d8e26737

Responses

200

This endpoint allows to fetch previously sent invitations. Your access token must be for a 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.

application/json

Schema

Schema

review_invitations

object[]

List of invitations sent

Array [

user_name string

user_id string

id string

sent-time string

]

page number

Current page number

max_page number

Last page number

count number

Number of resources complying with filters

Example (from schema)

{
  "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"
    }
  ],
  "page": 1,
  "max_page": 10,
  "count": 287
}

400

401

403

404

Loading...