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.

ActionEndpointMethodParameters
Create a noteNotesPOST subject
body
customer_id
order_id
request_id
task_id
Search productsProductsGET product_id
provider_id
active
product_type_id
description
code_1
View a customerCustomersGET* id
Replace an orderOrdersPUT id
pon
customer_id
order_type
status
provider_id
assigned_to
request_id
Delete a taskTasksDELETE* 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

ActionEndpointMethodParameters
View an addressAddressesGET* id
View a bill profileBillProfilesGET* id
View a packagePackagesGET* id

Different method

ActionEndpointMethodParameters
View a fileFilesGET* id
Delete a fileFilesDELETE* id

Different parameters

ActionEndpointMethodParameters
View a requestRequestsGET* id
Search requestsRequestsGET request_id
customer_id
request_status_id
request_status
assigned_to
created_date_start
* created_date_end
Download request PDFRequestsGET id
request_template_id
special_message
attach_pdf_to_request

Whatโ€™s Next

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