Zoho: Profiles
Zoho profiles.getProfiles: arguments, response, policy and SDK examples.
← Profiles operations · Get started
Operation zoho.getprofiles
Provider route: GET /crm/v8/settings/profiles. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["getProfiles"]>[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.getProfiles(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_profiles(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.type | string | Optional | One of: private_profile, normal_profile, portal_profile |
query.include_types | string | Optional | Allowed values (case-sensitive): Lite, Support. Use commas to include multiple. Maximum length: 50 Pattern: ^(Lite|Support)(,(Lite|Support))*$ |
query.filters | JSON | Optional | |
query.page | integer | Optional | Page number to retrieve. Default: 1 Format: int32 Minimum: 1 |
query.per_page | integer | Optional | Number of records per page. Default: 200 Format: int32 Maximum: 200 Minimum: 1 |
Response
Section titled “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 |
|---|---|---|---|
$ | object | Root | Successful response containing the list of CRM profiles and pagination info. Additional keys: not allowed |
info | JSON | Optional | Pagination and license usage information for the profiles list response. |
info (anyOf 1) | object | Alternative | Pagination metadata including count, page, per_page, and whether more records exist. Additional keys: not allowed |
info (anyOf 1).count | JSON | Required within parent | |
info (anyOf 1).count (anyOf 1) | integer | Alternative | Number of profiles returned in this response page. Format: int32 |
info (anyOf 1).count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info (anyOf 1).license_limit | JSON | Optional | |
info (anyOf 1).license_limit (anyOf 1) | integer | Alternative | Maximum number of profiles allowed by the organization’s license. Format: int32 |
info (anyOf 1).license_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info (anyOf 1).more_records | boolean | Required within parent | Indicates whether additional profiles exist beyond the current page. |
info (anyOf 1).page | JSON | Required within parent | |
info (anyOf 1).page (anyOf 1) | integer | Alternative | Current page number in the paginated result set. Format: int32 |
info (anyOf 1).page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info (anyOf 1).per_page | JSON | Required within parent | |
info (anyOf 1).per_page (anyOf 1) | integer | Alternative | Number of profiles returned per page. Format: int32 |
info (anyOf 1).per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
info (anyOf 2) | object | Alternative | License usage summary when full pagination data is not available. Additional keys: not allowed |
info (anyOf 2).license_limit | JSON | Required within parent | |
info (anyOf 2).license_limit (anyOf 1) | integer | Alternative | Maximum number of profiles allowed by the organization’s license. Format: int32 |
info (anyOf 2).license_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
profiles | array | Required within parent | List of profiles returned for this page (up to 200 entries). Maximum items: 200 |
profiles[] | object | Each item | Details of a single profile, including its permissions and section groupings. Additional keys: not allowed |
profiles[].$has_more | boolean | Optional | Indicates whether the profile has more permission records beyond the included set. |
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_]*$ |
profiles[].created_by | Model | Optional | Expand Profiles — response body — profiles item created by |
profiles[].created_time | Model | Required within parent | Expand Profiles — response body — profiles item created time |
profiles[].custom | boolean | Required within parent | Indicates whether the profile is a custom profile (`true`) or a system profile (`false`). |
profiles[].description | JSON | Optional | |
profiles[].description (anyOf 1) | string | Alternative | Optional description of the profile. Maximum length: 255 |
profiles[].description (anyOf 2) | null | Alternative | Optional description of the profile. Maximum length: 255 |
profiles[].display_label | string | Required within parent | Display label shown for the profile in the CRM UI. Maximum length: 255 |
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}$ |
profiles[].modified_by | Model | Optional | Expand Profiles — response body — profiles item modified by |
profiles[].modified_time | Model | Required within parent | Expand Profiles — response body — profiles item modified time |
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: ^[^ |
profiles[].permissions_details | array | Optional | Flat list of all individual permissions configured for this profile (up to 2000 entries). Maximum items: 2000 |
profiles[].permissions_details[] | object | Each item | A single permission entry describing a specific access right in the profile. Additional keys: not allowed |
profiles[].permissions_details[].active | boolean | Optional | Whether the permission is active. |
profiles[].permissions_details[].api_name | string | Optional | API name of the permission. Maximum length: 255 |
profiles[].permissions_details[].custom_permission | boolean | Optional | Whether this is a custom permission. |
profiles[].permissions_details[].customizable | boolean | Optional | Indicates whether this permission can be toggled on or off by an administrator. |
profiles[].permissions_details[].description | JSON | Optional | |
profiles[].permissions_details[].description (anyOf 1) | string | Alternative | Description of the permission. Maximum length: 500 |
profiles[].permissions_details[].description (anyOf 2) | null | Alternative | Description of the permission. Maximum length: 500 |
profiles[].permissions_details[].display_label | string | Optional | Human-readable label displayed for this permission in the CRM UI. Maximum length: 255 |
profiles[].permissions_details[].enabled | boolean | Optional | Indicates whether this permission is currently enabled for the profile. |
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}$ |
profiles[].permissions_details[].module | JSON | Optional | |
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 |
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 |
profiles[].permissions_details[].name | string | Optional | Internal API name of the permission. Maximum length: 255 |
profiles[].permissions_details[].parent_permissions | JSON | Optional | List of parent permission names that must be enabled before this permission can be enabled, or null when there are no parent dependencies. |
profiles[].permissions_details[].parent_permissions (anyOf 1) | array | Alternative | Array of parent permission identifiers this permission depends on. Maximum items: 200 |
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}$ |
profiles[].permissions_details[].parent_permissions (anyOf 2) | JSON | Alternative | Null when this permission has no parent dependencies. |
profiles[].permissions_details[].parent_permissions (anyOf 2) (allOf 1) | null | All variants apply | Represents a null value for optional fields. |
profiles[].permissions_details[].tooltip_msg | string | Optional | Tooltip text displayed when hovering over this permission in the CRM UI. Maximum length: 500 |
profiles[].sections | array | Optional | Grouped sections that organize permissions into categories for display in the CRM UI (up to 100 sections). Maximum items: 100 |
profiles[].sections[] | Model | Each item | Expand Profiles — response body — profiles item sections item |
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 |
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
Section titled “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
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getprofiles. Catalog operation: getProfiles. 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.