Get Organization Info

Purpose

To get the details of the organization.

Endpoints

GET /orginfo

Request Details

Request URL

https://contracts.zoho.com/api/v1/admin/orginfo

Authorization

Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6

Scope

contracts.meta.READ, contracts.contracts.ALL

Possible Operation Types

ALL - Full access to organization info
READ - Get organization info

Sample Request

Copiedcurl "https://contracts.zoho.com/v1/admin/orginfo"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.67013ab3960787bcf3affae67e649fc0.83a789c859e040bf11e7d05f9c8b5ef6"

Response JSON Keys

namestring
Represents the name of the organization.

idstring
Represents the unique ID of the organization.

country, city, state, address, buildingNo, zipCodestring
Represents the address details of the organization.

websitestring
Represents the website of the organization.

apiNamestring
Represents the name of the organization in the API.

phoneNumberstring
Represents the phone number of the organization.

currencyJSON Object
Represents the name, symbol, ISO code, default whole number, and decimal places for each currency field.

orgURLstring
Represents the URL of the organization.

accountownerJSON Object
Represents the name, user ID, and email ID of the account owner.

zoidlong
Represents the service organization ID of the organization.

Possible Errors

INVALID_URL_PATTERNHTTP 404

Request URL is incorrect

Resolution: Specify a valid request URL. Refer to the Request URL section above.

OAUTH_SCOPE_MISMATCHHTTP 401

Unauthorized

Resolution: Client does not have contracts.meta.READ scope. Create a new client with valid scope. Refer to the Scope section above.

NO_PERMISSIONHTTP 403

Permission denied to read

Resolution: The user does not have permission to read records. Contact your organization administrator.

INTERNAL_ERRORHTTP 500

Internal Server Error

Resolution: Unexpected and unhandled exception in the server.

INVALID_REQUEST_METHODHTTP 400

The HTTP request method is not a valid one.

Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section above.

AUTHORIZATION_FAILEDHTTP 400

The user does not have sufficient privilege to read module details.

Resolution: The user does not have permission to retrieve module details. Contact your organization administrator.

Sample Response

Copied{
  "organizationinfo": 
[
    {
      "country": String (country code),
      "zipCode": Long,
      "apiName": String,
      "address": String,
      "city": String,
      "zoid": Long,
      "orgURL": String,
      "webSite": String,
      "phoneNumber": String,
      "buildingNo": String,
      "accountowner": 
     {
        "displayName": String,
        "emailId": String,
        "id": String
      },
      "name": String,
      "currency": 
     {
        "currency_name": String,
        "currency_number": Integer,
        "currency_symbol": String,
        "currency_code": String,
        "currency_decimal": Integer
      },
      "id": String,
      "state": String
    }
  ]
}