Get a profile

GET/settings/profiles/{id}

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get a profile action (under Users).
Fill in the fields below, then reference the result from later steps as {{getAProfile.response.data}}.

Request

Path parameters

idstring (int64)required

Represents the unique identifier of the profile (64-bit integer represented as a string, 1-19 digits).

Response

Returns 200 with an object. Read it in later steps with {{getAProfile.response.data.<field>}}.

profilesarray<object>

Array containing the details of the requested profile (single-item array).

api_namestringrequired

API name of the profile, composed of alphanumeric characters and underscores and starting with a letter.

idstring (int64)required

Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits.

created_timeoneOfrequired

Creation timestamp of the profile - an ISO 8601 datetime string, or null when creation time is not available.

modified_timeoneOfrequired

Last modification timestamp of the profile - an ISO 8601 datetime string, or null when the modification time is not available.

namestringrequired

Display name for the profile, up to 50 characters, excluding the special characters `~`, `` ` ``, `#`, `%`, `^`, `&`, `*`, `(`, `)`, `+`, `|`, `,`, `=`, `{`, `}`, `;`, `[`, `]`, `"`.

display_labelstringrequired

Display label shown for the profile in the CRM UI.

modified_byoneOf

Last modifier of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when modifier information is not available.

descriptionstring | null

Optional description of the profile.

created_byoneOf

Creator of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when creator information is not available.

custombooleanrequired

Indicates whether the profile is a custom profile (`true`) or a system profile (`false`).

typestringrequired

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.

One ofprivate_profilenormal_profilelite_profilesystem_profileportal_profile

permissions_detailsarray<object>required12 fields

Flat list of all individual permissions configured for this profile (up to 2000 entries).

$has_moreboolean

Indicates whether the profile has more permission records beyond the included set.

sectionsarray<object>2 fields

Grouped sections that organize permissions into categories for display in the CRM UI (up to 100 sections).

json

{
  "profiles": [
    {
      "api_name": "Team_User",
      "id": "4832675000000850800",
      "created_time": null,
      "modified_time": null,
      "name": "Administrator",
      "display_label": "string",
      "custom": false,
      "type": "private_profile",
      "permissions_details": [
        {
          "display_label": "string",
          "module": "string",
          "name": "string",
          "customizable": false,
          "id": "4832675000000850800",
          "enabled": false,
          "tooltip_msg": "string",
          "api_name": "string",
          "active": false,
          "description": "string",
          "custom_permission": false,
          "parent_permissions": null
        }
      ],
      "modified_by": null,
      "description": "string",
      "created_by": null
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?