Using Acumatica REST API: Practical Requests, Limitations, and Workarounds

Part 1

Introduction

In today’s world, it’s hard to imagine a successful software product without an API. Fortunately, Acumatica is not an exception — it provides powerful REST API capabilities that allow real-time interaction with your data.

So, what do you need to know to get started?

While Acumatica University offers detailed guidance in its I310, I320, and I330 training sessions (with examples primarily using Postman), this article aims to give you a quick and practical introduction to making your first REST API calls using Postman.

What you'll need:

1. A deployed Acumatica instance (either locally or in the cloud)
2. Postman installed on your machine
3. A configured REST endpoint and a basic understanding of how to access it

Let’s dive in — the first step is logging in to your Acumatica system via the API.

Once you receive a 204 No Content response after login, it means authentication was successful — you’re now ready to access all available endpoints and data objects provided by Acumatica out of the box.

To explore these endpoints, open the SM207060 screen (or simply search for Web Service Endpoints in the system). On this screen, you’ll find a list of available endpoints. Select the desired Endpoint Name and Endpoint Version to begin working with the data structure.

You can also extend existing endpoints or create your own custom versions to expose additional fields or entities — but we’ll cover that in a later section.

Let get your first data from Customer object:

Method: GET

Here’s an example of a basic GET request to retrieve customer data:

http://localhost/SalesDemo24R2ACET/entity/Default/24.200.001/Customer/

Let’s break down the structure of this URL:

• http://localhost/SalesDemo24R2ACET/ — your Acumatica instance address
• entity/ — the base path for REST API calls
• Default/ — the endpoint name you selected in SM207060
• 24.200.001/ — the endpoint version
• Customer/ — the object (entity) you want to interact with

This request will return a list of all customers accessible through the selected endpoint. You can also use query parameters or filters to narrow down the result — we’ll cover that in the next section.

If you see a 200 OK status — congratulations on making your first successful request! 🎉

Final thoughts

As you can see, retrieving data and working with the Acumatica REST API is quite straightforward. However, this is just the beginning.

How can you select only the fields you need?
How do you retrieve a specific record?
How do filters work?
Can you expand details or linked entities?

We’ll cover all of that — and more — in the next part.

Stay tuned!