Rev.io Developers

Integrate with Rev.io through our REST API.

Get Started

Actions

Things you can do in our API.

What are actions?

Actions are basic tasks you can perform in our API, like creating a customer or running a report. They are essentially combinations of an endpoint, method, and set of available parameters. When you specify those three things in your API requests, you're telling us about the action you want to take.

πŸ“˜

Why "available parameters?"

One action always has the same set of parameters you can use. For example, when you're searching for customers, you can always specify an account number, bill profile ID, and status.

But you don't have to specify all of those each time you want to search for a customer. You could send us just an account number in one search, and just a status in another search.

What actions can I take?

For a full list of actions you can take through our API, visit our API Explorer! Here, we'll list some examples.

Action

Endpoint

Method

Parameters

Create a note

Notes

POST

  • subject
  • body
  • customer_id
  • order_id
  • request_id
  • task_id

Search products

Products

GET

  • product_id
  • provider_id
  • active
  • product_type_id
  • description
  • code_1

View a customer

Customers

GET

  • id

Replace an order

Orders

PUT

  • id
  • pon
  • customer_id
  • order_type
  • status
  • provider_id
  • assigned_to
  • request_id

Delete a task

Tasks

DELETE

  • id

What makes actions different from each other?

Our example actions above involve many different endpoints, methods, and parameters. But for many sets of actions, just one of these is different.

Different endpoint

Action

Endpoint

Method

Parameters

View an address

Addresses

GET

  • id

View a bill profile

BillProfiles

GET

  • id

View a package

Packages

GET

  • id

Different method

Action

Endpoint

Method

Parameters

View a file

Files

GET

  • id

Delete a file

Files

DELETE

  • id

Different parameters

Action

Endpoint

Method

Parameters

View a request

Requests

GET

  • id

Search requests

Requests

GET

  • request_id
  • customer_id
  • request_status_id
  • request_status
  • assigned_to
  • created_date_start
  • created_date_end

Download request PDF

Requests

GET

  • id
  • request_template_id
  • special_message
  • attach_pdf_to_request

Updated 3 years ago


What's Next

Let's take a closer look at how you perform actions: through endpoints.

Endpoints

Actions


Things you can do in our API.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.