Contacts

As the name suggests, contacts are a core part of Review Rover — the very reason Review Rover exists is so you can communicate with your contacts. On this page, we'll dive into the different contact endpoints you can use to manage contacts programmatically. We'll look at how to query, create, update, and delete contacts.

The contact model

The contact model contains all the information about your contacts, such as their email, company, and phone number.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the contact.

  • Name
    account_id
    Type
    string
    Description

    The ID of the Account the Contact belongs to.

  • Name
    email
    Type
    string
    Description

    The email for the contact.

  • Name
    first_name
    Type
    string
    Description

    The contact's first name.

  • Name
    last_name
    Type
    string
    Description

    The contact's last name.

  • Name
    phone
    Type
    string
    Description

    The phone number for the contact.

  • Name
    company
    Type
    string
    Description

    The company for the contact.

  • Name
    position
    Type
    string
    Description

    The position for the contact.

  • Name
    updated_at
    Type
    timestamp
    Description

    Timestamp of when the contact was last updated.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp of when the contact was created.

GET/v1/contacts

List all contacts

This endpoint allows you to retrieve a paginated list of all your contacts. By default, a maximum of ten contacts are shown per page.

Optional attributes

  • Name
    limit
    Type
    integer
    Description

    Limit the number of contacts returned.

Request

GET
/v1/contacts
curl -G https://dashboard.reviewrover.co/api/v1/contacts \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "cont_KYdl3lftgZXGRbxqoj",
      "account_id": "acct_j4y1qljfj3kQHbwp0BWLYGz",
      "email": "[email protected]",
      "first_name": "Frank",
      "last_name": "McCallister",
      "phone": "1-800-759-3000",
      "company": "The Plaza Hotel",
      "position": "Manager",
      "created_at": "2025-02-17T02:00:34Z",
      "updated_at": "2025-02-17T02:00:34Z"
    },
    {
      "id": "cont_sksfkKvkalfGRbxqoj",
      // ...
    }
  ]
}
POST/v1/contacts

Create a contact

This endpoint allows you to add a new contact to your contact list in Review Rover. To add a contact, you must provide their email as well as any optional attributes.

Required attributes

  • Name
    email
    Type
    string
    Description

    The email for the contact.

Optional attributes

  • Name
    first_name
    Type
    string
    Description

    The contact's first name.

  • Name
    last_name
    Type
    string
    Description

    The contact's last name.

  • Name
    phone
    Type
    string
    Description

    The phone number for the contact.

  • Name
    company
    Type
    string
    Description

    The company for the contact.

  • Name
    position
    Type
    string
    Description

    The position for the contact.

Request

POST
/v1/contacts
curl https://dashboard.reviewrover.co/api/v1/contacts \
  -H "Authorization: Bearer {token}" \
  -d email="[email protected]" \
  -d phone_number="1-800-759-3000" \
  -d first_name="Frank" \
  -d last_name="McCallister"

Response

{
  "id": "cont_KYdl3lftgZXGRbxqoj",
  "account_id": "acct_j4y1qljfj3kQHbwp0BWLYGz",
  "email": "[email protected]",
  "first_name": "Frank",
  "last_name": "McCallister",
  "phone": "1-800-759-3000",
  "created_at": "2025-02-17T02:00:34Z",
  "updated_at": "2025-02-17T02:00:34Z"
}
GET/v1/contacts/:id

Retrieve a contact

This endpoint allows you to retrieve a contact by providing their Review Rover id. Refer to the list at the top of this page to see which properties are included with contact objects.

Request

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

Response

{
  "id": "cont_KYdl3lftgZXGRbxqoj",
  "account_id": "acct_j4y1qljfj3kQHbwp0BWLYGz",
  "email": "[email protected]",
  "first_name": "Frank",
  "last_name": "McCallister",
  "phone": "1-800-759-3000",
  "company": "The Plaza Hotel",
  "position": "Manager",
  "created_at": "2025-02-17T02:00:34Z",
  "updated_at": "2025-02-17T02:00:34Z"
}
PUT/v1/contacts/:id

Update a contact

This endpoint allows you to perform an update on a contact. Refer to the list at the top of this page to see which properties are included with contact objects.

Optional attributes

  • Name
    first_name
    Type
    string
    Description

    The contact's first name.

  • Name
    last_name
    Type
    string
    Description

    The contact's last name.

  • Name
    phone
    Type
    string
    Description

    The phone number for the contact.

  • Name
    company
    Type
    string
    Description

    The company for the contact.

  • Name
    position
    Type
    string
    Description

    The position for the contact.

Request

PUT
/v1/contacts/cont_KYdl3lftgZXGRbxqoj
curl -X PUT https://dashboard.reviewrover.co/api/v1/contacts/cont_KYdl3lftgZXGRbxqoj \
  -H "Authorization: Bearer {token}" \
  -d display_name="UncleFrank"

Response

{
  "id": "cont_KYdl3lftgZXGRbxqoj",
  "account_id": "acct_j4y1qljfj3kQHbwp0BWLYGz",
  "email": "[email protected]",
  "first_name": "Frank",
  "last_name": "McCallister",
  "phone": "1-800-759-3000",
  "company": "The Plaza Hotel",
  "position": "Manager",
  "created_at": "2025-02-17T02:00:34Z",
  "updated_at": "2025-02-17T02:00:34Z"
}
DELETE/v1/contacts/:id

Delete a contact

This endpoint allows you to delete contacts from your contact list in Review Rover.

Request

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