Visits

Visits represent service appointments or completed jobs for your contacts. Linking a visit to a contact creates an event that can trigger automated review request campaigns.

The visit model

Properties

Name
id
Type
integer
Description
Unique identifier for the visit.
Name
external_id
Type
string
Description
Your system's ID for this visit. Can be used in place of id in requests.
Name
time_scheduled
Type
timestamp
Description
When the visit was scheduled.
Name
time_completed
Type
timestamp
Description
When the visit was completed.
Name
amount_collected
Type
decimal
Description
Amount collected during the visit.
Name
date_cancelled
Type
timestamp
Description
If cancelled, when the visit was cancelled.
Name
completed
Type
boolean
Description
Whether the visit has been completed.
Name
contact_id
Type
string
Description
ID of the associated contact.
Name
event_date
Type
timestamp
Description
The event date used for campaign scheduling.
Name
created_at
Type
timestamp
Description
Timestamp of when the visit was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the visit was last updated.

GET/v1/visits

List all visits

Optional attributes

Name
limit
Type
integer
Description
Results per page (1–100). Defaults to 25.
Name
page
Type
integer
Description
Page number. Defaults to 1.

Request

GET

/v1/visits

curl https://dashboard.reviewrover.co/api/v1/visits \
  -H "Authorization: Bearer {token}"

Response

{
  "visits": [
    {
      "id": 1,
      "external_id": "vis_001",
      "time_scheduled": "2025-02-17T09:00:00Z",
      "time_completed": "2025-02-17T10:30:00Z",
      "amount_collected": "120.00",
      "completed": true,
      "contact_id": "cont_KYdl3lftgZXGRbxqoj",
      "event_date": "2025-02-17T10:30:00Z",
      "created_at": "2025-02-17T02:00:34Z",
      "updated_at": "2025-02-17T02:00:34Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 1,
    "total_pages": 1
  }
}

POST/v1/visits

Create a visit

Required attributes

Name
contact_id
Type
string
Description
ID of the contact this visit belongs to.

Optional attributes

Name
external_id
Type
string
Description
Your system's ID for this visit.
Name
time_scheduled
Type
timestamp
Description
When the visit is scheduled.
Name
time_completed
Type
timestamp
Description
When the visit was completed.
Name
amount_collected
Type
decimal
Description
Amount collected.
Name
date_cancelled
Type
timestamp
Description
When the visit was cancelled, if applicable.
Name
event_date
Type
timestamp
Description
Event date for campaign scheduling. Defaults to time_scheduled.

Request

POST

/v1/visits

curl https://dashboard.reviewrover.co/api/v1/visits \
  -H "Authorization: Bearer {token}" \
  -d contact_id="cont_KYdl3lftgZXGRbxqoj" \
  -d external_id="vis_001" \
  -d time_scheduled="2025-02-17T09:00:00Z" \
  -d time_completed="2025-02-17T10:30:00Z"

Response

{
  "id": 1,
  "external_id": "vis_001",
  "time_scheduled": "2025-02-17T09:00:00Z",
  "time_completed": "2025-02-17T10:30:00Z",
  "completed": true,
  "contact_id": "cont_KYdl3lftgZXGRbxqoj",
  "event_date": "2025-02-17T09:00:00Z",
  "created_at": "2025-02-17T02:00:34Z",
  "updated_at": "2025-02-17T02:00:34Z"
}

GET/v1/visits/:id

Retrieve a visit

Retrieve by numeric ID or external_id.

Request

GET

/v1/visits/vis_001

curl https://dashboard.reviewrover.co/api/v1/visits/vis_001 \
  -H "Authorization: Bearer {token}"

PUT/v1/visits/:id

Update a visit

Optional attributes

Name
time_scheduled
Type
timestamp
Description
Updated scheduled time.
Name
time_completed
Type
timestamp
Description
Updated completion time.
Name
amount_collected
Type
decimal
Description
Updated amount.
Name
date_cancelled
Type
timestamp
Description
Cancellation date.
Name
event_date
Type
timestamp
Description
Updated event date.

Request

PUT

/v1/visits/1

curl -X PUT https://dashboard.reviewrover.co/api/v1/visits/1 \
  -H "Authorization: Bearer {token}" \
  -d time_completed="2025-02-17T11:00:00Z"

DELETE/v1/visits/:id

Delete a visit

Permanently deletes a visit.

Request

DELETE

/v1/visits/1

curl -X DELETE https://dashboard.reviewrover.co/api/v1/visits/1 \
  -H "Authorization: Bearer {token}"