Skip to main content
GET
/
accounts
List accounts
curl --request GET \
  --url https://api.arcuserp.com/v1/accounts \
  --header 'Authorization: Bearer <token>'
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
search
string

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