Zoho: Profile — profiles get Profile

← Profiles operations · Get started

Operation zoho.getprofile

Provider route: GET /crm/v8/settings/profiles/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["profiles"]["getProfile"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.profiles.getProfile(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.profiles.get_profile(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Successful response containing the requested profile’s details. Additional keys: not allowed
$ (anyOf 1).profiles	array	Required within parent	Array containing the details of the requested profile (single-item array). Maximum items: 1
$ (anyOf 1).profiles[]	object	Each item	Full details of the requested profile. Additional keys: not allowed
$ (anyOf 1).profiles[].$has_more	boolean	Optional	Indicates whether the profile has more permission records beyond the included set.
$ (anyOf 1).profiles[].api_name	string	Required within parent	API name of the profile, composed of alphanumeric characters and underscores and starting with a letter. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
$ (anyOf 1).profiles[].created_by	Model	Optional	Expand Profiles — response body — profiles item created by
$ (anyOf 1).profiles[].created_time	Model	Required within parent	Expand Profiles — response body — profiles item created time
$ (anyOf 1).profiles[].custom	boolean	Required within parent	Indicates whether the profile is a custom profile (`true`) or a system profile (`false`).
$ (anyOf 1).profiles[].description	JSON	Optional
$ (anyOf 1).profiles[].description (anyOf 1)	string	Alternative	Optional description of the profile. Maximum length: 255
$ (anyOf 1).profiles[].description (anyOf 2)	null	Alternative	Optional description of the profile. Maximum length: 255
$ (anyOf 1).profiles[].display_label	string	Required within parent	Display label shown for the profile in the CRM UI. Maximum length: 255
$ (anyOf 1).profiles[].id	string	Required within parent	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. Unique profile identifier. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
$ (anyOf 1).profiles[].modified_by	Model	Optional	Expand Profiles — response body — profiles item modified by
$ (anyOf 1).profiles[].modified_time	Model	Required within parent	Expand Profiles — response body — profiles item modified time
$ (anyOf 1).profiles[].name	string	Required within parent	Display name for the profile, up to 50 characters, excluding the special characters ``, “ ` “, `#`, `%`, `^`, `&`, `*`, `(`, `)`, `+`, `|`, `,`, `=`, `{`, `}`, `;`, `[`, `]`, `”`. Maximum length: 50 Minimum length: 1 Pattern: ^[^`#%^&*()+|,={};[]”]+$
$ (anyOf 1).profiles[].permissions_details	array	Required within parent	Flat list of all individual permissions configured for this profile (up to 2000 entries). Maximum items: 2000
$ (anyOf 1).profiles[].permissions_details[]	object	Each item	A single permission entry describing a specific access right in the profile. Additional keys: not allowed
$ (anyOf 1).profiles[].permissions_details[].active	boolean	Optional	Whether the permission is active.
$ (anyOf 1).profiles[].permissions_details[].api_name	string	Optional	API name of the permission. Maximum length: 255
$ (anyOf 1).profiles[].permissions_details[].custom_permission	boolean	Optional	Whether this is a custom permission.
$ (anyOf 1).profiles[].permissions_details[].customizable	boolean	Optional	Indicates whether this permission can be toggled on or off by an administrator.
$ (anyOf 1).profiles[].permissions_details[].description	JSON	Optional
$ (anyOf 1).profiles[].permissions_details[].description (anyOf 1)	string	Alternative	Description of the permission. Maximum length: 500
$ (anyOf 1).profiles[].permissions_details[].description (anyOf 2)	null	Alternative	Description of the permission. Maximum length: 500
$ (anyOf 1).profiles[].permissions_details[].display_label	string	Optional	Human-readable label displayed for this permission in the CRM UI. Maximum length: 255
$ (anyOf 1).profiles[].permissions_details[].enabled	boolean	Optional	Indicates whether this permission is currently enabled for the profile.
$ (anyOf 1).profiles[].permissions_details[].id	string	Optional	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. The unique identifier of the permission. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
$ (anyOf 1).profiles[].permissions_details[].module	JSON	Optional
$ (anyOf 1).profiles[].permissions_details[].module (anyOf 1)	string	Alternative	Module associated with this permission. Null when the permission is not tied to a specific module. Maximum length: 100
$ (anyOf 1).profiles[].permissions_details[].module (anyOf 2)	null	Alternative	Module associated with this permission. Null when the permission is not tied to a specific module. Maximum length: 100
$ (anyOf 1).profiles[].permissions_details[].name	string	Optional	Internal API name of the permission. Maximum length: 255
$ (anyOf 1).profiles[].permissions_details[].parent_permissions	JSON	Optional	List of parent permission names this permission depends on, or null when there are no parent dependencies.
$ (anyOf 1).profiles[].permissions_details[].parent_permissions (anyOf 1)	array	Alternative	Array of parent permission identifiers this permission depends on. Maximum items: 200
$ (anyOf 1).profiles[].permissions_details[].parent_permissions (anyOf 1)[]	string	Each item	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
$ (anyOf 1).profiles[].permissions_details[].parent_permissions (anyOf 2)	JSON	Alternative	Null when this permission has no parent dependencies.
$ (anyOf 1).profiles[].permissions_details[].parent_permissions (anyOf 2) (allOf 1)	null	All variants apply	Represents a null value for optional fields.
$ (anyOf 1).profiles[].permissions_details[].tooltip_msg	string	Optional	Tooltip text displayed when hovering over this permission in the CRM UI. Maximum length: 500
$ (anyOf 1).profiles[].sections	array	Optional	Grouped sections that organize permissions into categories for display in the CRM UI (up to 100 sections). Maximum items: 100
$ (anyOf 1).profiles[].sections[]	Model	Each item	Expand Profiles — response body — profiles item sections item
$ (anyOf 1).profiles[].type	string	Required within parent	Profile type classification. Possible values: `private_profile`, `normal_profile`, `lite_profile`, `system_profile`, `portal_profile`. `private_profile` is used exclusively for team modules; non-private profiles are not allowed for team modules. Known values: private_profile, normal_profile, lite_profile, system_profile, portal_profile
$ (anyOf 2)	null	Alternative

Referenced models: Profiles — response body — profiles item modified time, Profiles — response body — profiles item created by, Profiles — response body — profiles item created time, Profiles — response body — profiles item modified by, Profiles — response body — profiles item sections item

Schemas

Profiles — response body — profiles item modified time

Field	Type	Presence	Description and constraints
$	JSON	Root	Last modification timestamp of the profile - an ISO 8601 datetime string, or null when the modification time is not available.
$ (anyOf 1)	JSON	Alternative	Profile last-modified timestamp.
$ (anyOf 1) (allOf 1)	string	All variants apply	ISO 8601 datetime string with timezone offset representing when the profile action was performed (for example, `2024-05-17T09:15:56+05:30`). Format: date-time
$ (anyOf 2)	JSON	Alternative	Null when modification time is not available.
$ (anyOf 2) (allOf 1)	null	All variants apply	Represents a null value for optional fields.

Profiles — response body — profiles item created by

Field	Type	Presence	Description and constraints
$	JSON	Root	Creator of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when creator information is not available.
$ (anyOf 1)	JSON	Alternative	User who created the profile.
$ (anyOf 1) (allOf 1)	Model	All variants apply	Expand Profiles — response body — profiles item created by id, name id, name
$ (anyOf 2)	JSON	Alternative	Null when creator information is not available.
$ (anyOf 2) (allOf 1)	null	All variants apply	Represents a null value for optional fields.

Referenced models: Profiles — response body — profiles item created by id, name id, name

Profiles — response body — profiles item created time

Field	Type	Presence	Description and constraints
$	JSON	Root	Creation timestamp of the profile - an ISO 8601 datetime string, or null when creation time is not available.
$ (anyOf 1)	JSON	Alternative	Profile creation timestamp.
$ (anyOf 1) (allOf 1)	string	All variants apply	ISO 8601 datetime string with timezone offset representing when the profile action was performed (for example, `2024-05-17T09:15:56+05:30`). Format: date-time
$ (anyOf 2)	JSON	Alternative	Null when creation time is not available.
$ (anyOf 2) (allOf 1)	null	All variants apply	Represents a null value for optional fields.

Profiles — response body — profiles item modified by

Field	Type	Presence	Description and constraints
$	JSON	Root	Last modifier of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when modifier information is not available.
$ (anyOf 1)	JSON	Alternative	User who last modified the profile.
$ (anyOf 1) (allOf 1)	Model	All variants apply	Expand Profiles — response body — profiles item created by id, name id, name
$ (anyOf 2)	JSON	Alternative	Null when modifier information is not available.
$ (anyOf 2) (allOf 1)	null	All variants apply	Represents a null value for optional fields.

Referenced models: Profiles — response body — profiles item created by id, name id, name

Profiles — response body — profiles item sections item

Field	Type	Presence	Description and constraints
$	object	Root	A section grouping related permission categories. Additional keys: not allowed
categories	array	Required within parent	List of permission categories within this section (up to 100 categories). Maximum items: 100
categories[]	Model	Each item	Expand Profiles — response body — profiles item sections item categories item
name	string	Required within parent	Internal name of the permission section. Maximum length: 255

Referenced models: Profiles — response body — profiles item sections item categories item

Profiles — response body — profiles item created by id, name id, name

Field	Type	Presence	Description and constraints
$	object	Root	Reference to the CRM user who performed an action on a profile. Additional keys: not allowed
id	string	Required within parent	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Display name of the user as shown in Zoho CRM. Maximum length: 100 Minimum length: 1

Profiles — response body — profiles item sections item categories item

Field	Type	Presence	Description and constraints
$	object	Root	A single permission category containing related permissions. Additional keys: not allowed
display_label	string	Required within parent	Display label shown for this category in the CRM UI. Maximum length: 255
module	JSON	Optional
module (anyOf 1)	string	Alternative	Module associated with this category or null when the category is not module-specific. Maximum length: 100
module (anyOf 2)	null	Alternative	Module associated with this category or null when the category is not module-specific. Maximum length: 100
name	string	Required within parent	Internal name of the permission category. Maximum length: 255
permissions_details	array	Required within parent	Permission identifiers grouped under this category. Maximum items: 500 Minimum items: 0
permissions_details[]	string	Each item	A single permission identifier string associated with this category. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getprofile. Catalog operation: getProfile. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source