Skip to main content
GET
/
accounts
List accounts
curl --request GET \
  --url https://api.arcuserp.com/v1/accounts \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.arcuserp.com/v1/accounts"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.arcuserp.com/v1/accounts"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/accounts")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "a1b2c3d4-0001-0001-0001-000000000001",
      "object": "account",
      "entity_id": "ent-uuid-here",
      "display_name": "Acme Corp",
      "company_name": "Acme Corporation",
      "account_type": "business",
      "account_number": "CUST-00042",
      "email": "orders@acme.com",
      "phone_main": "212-555-0100",
      "credit_limit": 50000,
      "credit_balance": 12500,
      "is_credit_hold": false,
      "tax_exempt": false,
      "is_active": true,
      "created_at": "2025-01-15T10:00:00Z",
      "updated_at": "2026-04-01T08:30:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 25,
  "total_pages": 1
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Query Parameters

account_type
enum<string>

Filter by account type. 'customer' is a synthetic alias for business/individual/lead.

Available options:
business,
individual,
lead,
vendor,
all

Full-text search via accounts.searchable_text.

is_active
enum<string>

Filter by active status. Default returns all.

Available options:
true,
false,
all
include_inactive
boolean

Legacy alias for is_active=all.

page
integer
default:1
per_page
integer
default:25
Required range: x <= 100
expand[]
enum<string>[]
Available options:
data.addresses,
data.contacts,
data.payment_methods,
data.default_payment_method,
data.recent_orders,
data.credit_terms

Response

Paginated account list

data
object[]
total
integer
page
integer
per_page
integer
total_pages
integer