Developer Hub

CA Office Automation REST API Documentation

Discover and explore our API documentation for seamless integration.

Secure Auth RESTful API JSON Responses

Last updated: August 2026 · By CAOA Technical Team · Capterra Verified

Overview

Explore our comprehensive API documentation to discover the various endpoints, methods, and parameters available for integrating with our platform. The documentation provides detailed information and examples to help you understand and utilize the API effectively in your custom solutions.

All API requests require authentication headers. You will receive your caoa_keys and caoa_seckey credentials from the CAOA technical team upon onboarding. Keep these credentials secure and never expose them on the client side. For general HTTP header conventions, see MDN HTTP Headers reference. For HTTP status code meanings, see MDN HTTP Status Codes.

Looking to explore the full platform? See our 8+ practice management modules, SaaS services, or pricing plans.

Base URL

api.caoasoftware.com

Response Format

JSON

Authentication

Header-based Keys

Protocol

HTTPS only

GET

Get a Client List from CAOA

Retrieve a full list of clients associated with your CAOA account. Returns an array of client objects with all profile fields.

Endpoint URL

GET https://api.caoasoftware.com/api/GClient/getClients

Request Headers

Header	Type	Required	Description
`caoa_keys`	string	Required	Your unique API key provided by the CAOA technical team.
`caoa_seckey`	string	Required	Your unique secret key provided by the CAOA technical team.

Code Example

Replace caoa_keys and caoa_seckey in the example below with your actual credentials received from the CAOA technical team.

Node.js

var request = require('request');

var options = {
  'method': 'GET',
  'url': 'https://api.caoasoftware.com/api/GClient/getClients',
  'headers': {
    'caoa_keys':    'YOUR_CAOA_KEY',
    'caoa_seckey': 'YOUR_CAOA_SECKEY'
  }
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Responses

200 OK

JSON Response

[
  {
    "id":              4,
    "cl_name":       "ca office automation",
    "cl_code":       "cl01",
    "cl_group":      "General",
    "cl_itstatus":   "Private Limited",
    "cl_mastypes":   "Client",
    "cl_submaster":  "",
    "cl_address":    "Iscon Ambali Road, Ambali",
    "cl_country":    "India",
    "cl_state":      "Gujarat",
    "cl_city":       "Ahmedabad",
    "cl_postalcode": "380058",
    "cl_email":      "xyz@gmail.com",
    "cl_mobile":     "0000000000",
    "cl_Finyear":    "April-March",
    "cl_currency":   "INR",
    "cl_panno":      "abc.....",
    "cl_gstin":      "",
    "cl_aadhar":     "",
    "cl_birthdate":  "",
    "cl_status":     "Active",
    "cl_description": ""
  },
  {
    "id":              5,
    "cl_name":       "abc pvt ltd",
    "cl_code":       "abc",
    "cl_group":      "General",
    "cl_itstatus":   "LLP",
    "cl_mastypes":   "Client",
    "cl_submaster":  "ACC",
    "cl_address":    "Bopal, Ahmedabad",
    "cl_country":    "India",
    "cl_state":      "Gujarat",
    "cl_city":       "Ahmedabad",
    "cl_postalcode": "380054",
    "cl_email":      "abc@gmail.com",
    "cl_mobile":     "9999999999",
    "cl_Finyear":    "January-December",
    "cl_currency":   "USD",
    "cl_panno":      "xxxxxxxx",
    "cl_gstin":      "",
    "cl_aadhar":     "",
    "cl_birthdate":  "22-10-1986",
    "cl_status":     "Active",
    "cl_description": ""
  }
]

200 OK — Empty

Returned when the request is valid but no clients exist in your account yet.

                    JSON Response
                  
                  []

400 Bad Request

Returned when authentication headers are missing, invalid, or the request is malformed. Verify that your caoa_keys and caoa_seckey are correct.

Common causes: Invalid or expired API keys, incorrect header names, or missing authentication headers. Contact the CAOA technical team to regenerate your credentials if the issue persists.

Response Fields Reference

Description of all fields returned in the client object.

Field	Type	Description
`id`	integer	Unique client identifier
`cl_name`	string	Full name of the client
`cl_code`	string	Short client code for identification
`cl_group`	string	Client group category
`cl_itstatus`	string	IT/legal entity status (e.g. Private Limited, LLP)
`cl_mastypes`	string	Master type classification
`cl_submaster`	string	Sub-master classification
`cl_address`	string	Registered address
`cl_country`	string	Country
`cl_state`	string	State / Province
`cl_city`	string	City
`cl_postalcode`	string	Postal / ZIP code
`cl_email`	string	Primary email address
`cl_mobile`	string	Mobile phone number
`cl_Finyear`	string	Financial year period (e.g. April-March)
`cl_currency`	string	Preferred currency code (e.g. INR, USD)
`cl_panno`	string	PAN number
`cl_gstin`	string	GST identification number
`cl_aadhar`	string	Aadhaar number
`cl_birthdate`	string	Date of birth (DD-MM-YYYY)
`cl_status`	string	Client status — Active or Inactive
`cl_description`	string	Optional notes or description

Dedicated API Support

Our dedicated engineering and support teams are committed to assisting you with any API-related issues you may encounter. Whether you have questions, need technical guidance, or require troubleshooting assistance, our knowledgeable experts are readily available to provide timely and effective solutions, ensuring a smooth and seamless experience with our API.

Email Support Team General Inquiry

CAOA Developer Program

Ready to Integrate?
Get Your API Keys Today

Reach out to the CAOA technical team to receive your API credentials and start building seamless integrations with your accounting workflow.

Request API Access Schedule a Demo