Get an Organization Details

Zoho Books API: Get an Organization Details

Zoho Books API: Get an Organization Details

The Get an Organization API is used to retrieve the complete profile and configuration settings of a specific organization in Zoho Books. Unlike the "List Organizations" endpoint, this provides granular data, including address details and specific regional settings.

1. Endpoint Details

2. Authentication & Scopes

To access this endpoint, you must include a valid OAuth 2.0 access token in the header.

  • Header: Authorization: Zoho-oauthtoken <YOUR_ACCESS_TOKEN>

  • Required Scope: ZohoBooks.organizations.READ

3. Path Parameters

ParameterTypeDescription
organization_idStringThe unique identifier of the organization you wish to fetch.

4. Sample JSON Response

A successful request (HTTP 200) returns an organization object:

JSON
{
"code": 0,
"message": "success",
"organization": {
"organization_id": "10234695",
"name": "Kalki LLP - Tech Solutions",
"contact_name": "Admin User",
"email": "admin@kalkillp.com",
"is_active": true,
"currency_id": "460000000000097",
"currency_code": "USD",
"currency_symbol": "$",
"currency_format": "1,234,567.89",
"price_precision": 2,
"time_zone": "America/New_York",
"date_format": "yyyy-MM-dd",
"field_separator": "comma",
"fiscal_year_start_month": 1,
"address": "123 Tech Park",
"city": "Austin",
"state": "Texas",
"zip": "73301",
"country": "USA",
"phone": "123-456-7890",
"website": "www.kalkillp.com"
}
}

5. Implementation Example (Zoho Deluge)

If you are working within the Zoho ecosystem (Creator, CRM, or Books Custom Functions), use the following script:

JavaScript
// Replace with your actual Organization ID
orgID = "10234695";

response = invokeurl
[
url :"https://www.zohoapis.com/books/v3/organizations/" + orgID
type :GET
connection:"zoho_books_connection" // Ensure this connection has organizations.READ scope
];

if(response.get("code") == 0)
{
orgDetails = response.get("organization");
info "Organization Name: " + orgDetails.get("name");
info "Base Currency: " + orgDetails.get("currency_code");
}
else
{
info "Error fetching data: " + response.get("message");
}

6. Troubleshooting & Common Errors

CodeMessageResolution
57Invalid organization_idThe ID in the URL is incorrect or does not exist in your account.
6024User belongs to multiple organizations...You must explicitly pass the organization_id as a path parameter (which this endpoint requires).
401UnauthorizedThe access token is expired or the scope ZohoBooks.organizations.READ was not granted during OAuth.
429Rate Limit ExceededZoho Books limits API calls to 100 requests per minute. Implement a retry-after logic.
    • Related Articles

    • Zoho Books API v3: Updating Organization Settings

      Zoho Books API v3: Updating Organization Settings Maintaining accurate business details is critical for compliance and professional branding. While many settings are configured during setup, your integration may need to update organization-level ...
    • Zoho Books API v3: Updating Contact Information

      Zoho Books API v3: Updating Contact Information Business relationships are dynamic—addresses change, contact persons move, and tax statuses get updated. The Update a Contact API allows you to programmatically modify any attribute of an existing ...
    • Zoho Books API v3: The Complete Developer Setup & Error Reference

      Zoho Books API v3: The Complete Developer Setup & Error Reference At Kalki LLP, we specialize in helping businesses bridge the gap between their custom software and Zoho Finance. This guide provides a detailed technical breakdown of the Zoho Books ...
    • Zoho Books API v3: Managing Organizations (Creation & Configuration)

      Zoho Books API v3: Managing Organizations (Creation & Configuration) In the Zoho ecosystem, an Organization is your distinct accounting entity. Whether you are a small business with one ledger or a conglomerate with fifty, the Organizations API ...
    • Zoho Books API v3: Adding Additional Addresses to a Contact

      Zoho Books API v3: Adding Additional Addresses to a Contact The Add Additional Address API allows you to store supplemental location data for a customer or vendor. These addresses are distinct from the primary billing/shipping fields and are ...