Synupv1
Create a key
v1Resources/Review Invites/getSearch recipients

Search recipients

Searches recipients by name, email, or phone across your agency's review-invite campaigns.

get/api/v1/review-invites
review-invite:read
Query parameters
querystringrequired
Search text, matched against name, email, and phone. Required.
limitintegeroptional
Max results to return, 1–100. Defaults to 25.
Response
dataobjectoptional
recipientsarray of objectoptional
The matching recipients.
idstringoptional
Unique identifier for the recipient.
namestringoptional
The recipient's name, or empty if not provided.
emailstringoptional
The recipient's email address, or empty if not provided.
phonestringoptional
The recipient's phone number, or empty if not provided.
sourcestringoptional
Where this recipient came from, e.g. manual, csv, crm.
contactTypestringoptional
One of: Customer, Lead, Prospect, Contact.
statusstringoptional
Current delivery status for this recipient.
campaignIdstringoptional
ID of the campaign this recipient belongs to.
campaignNamestringoptional
Name of the campaign this recipient belongs to.
locationIdstringoptional
ID of the location the campaign is for, or null.
locationLabelstringoptional
Display name of that location, or empty when it can't be resolved.
alreadyMessagedbooleanoptional
Whether a message has already been sent to this recipient. Once true, their email and phone can no longer be changed.
countnumberoptional
Total number of recipients matching the search.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/review-invites
Your API key
query *
limit
{
  "data": {
    "recipients": [
      {
        "id": "cm_recip_1",
        "name": "Jordan Lee",
        "email": "jordan@example.com",
        "phone": "",
        "source": "manual",
        "contactType": "Customer",
        "status": "pending",
        "campaignId": "cm_campaign_1",
        "campaignName": "Spring Checkup Follow-up",
        "locationId": "cm_loc_1",
        "locationLabel": "Acme Dental — Downtown · Austin",
        "alreadyMessaged": false
      }
    ],
    "count": 1
  }
}