List GL accounts (chart of accounts)

Required API key scope: accounting:read

Returns all GL accounts for the authenticated entity. Supports filtering by account type, postability (leaf accounts only), and system account key.

Use postable_only=true when building journal entry line pickers — this enforces Rule 21 (no header accounts) on the client side.

GET /gl-accounts

List GL accounts (chart of accounts)

cURL

curl --request GET \
  --url https://api.arcuserp.com/v1/gl-accounts \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.arcuserp.com/v1/gl-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/gl-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/gl-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/gl-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/gl-accounts")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/gl-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

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_number": "<string>",
      "name": "<string>",
      "description": "<string>",
      "account_sub_type": "<string>",
      "is_header": true,
      "parent_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_system_account": true,
      "system_account_key": "<string>",
      "is_bank_account": true,
      "is_active": true,
      "tax_line_mapping": "<string>",
      "opening_balance": 123,
      "opening_balance_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "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

Available options: asset, liability, equity, revenue, expense, cogs

is_active · boolean

Filter by active status (default true)

postable_only · boolean

When true, returns only leaf accounts (is_header=false, is_active=true). Use for GL pickers to enforce Rule 21 (no header account postings).

system_account_key · string

Filter by system_account_key (e.g. ar_account, cogs, revenue)

is_bank_account · boolean

When true, returns only bank account leaves

context · enum<string>

Canonical context filter (Rule 21 preferred pattern). Restricts accounts to those appropriate for the given posting context.

Available options: manual_je_line, ap_bill_expense_line, ar_invoice_revenue_line, bank_rec_line, inventory_adj_line, payment_clearing, cogs_posting

search · string

Search by account name or number

Response

200

application/json

Paginated list of GL accounts

data · object[]

Show child attributes