List profiles

GET/settings/profiles

Use it in a workflow

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

Request

Query parameters

typestring

Filters the returned profiles by profile type. Use `private_profile` to retrieve profiles used exclusively with team modules - private profiles are not allowed for normal custom modules, and non-private profiles are not allowed for team modules. **Possible values:** **`private_profile`**, **`normal_profile`**, **`portal_profile`**.

One ofprivate_profilenormal_profileportal_profile

include_typesstring

Comma-separated list of additional profile types to include alongside the default Administrator, Standard, and custom profiles. Accepted pattern: `(Lite|Support)(,(Lite|Support))*`.

filtersany

JSON-encoded filter criteria to narrow the profiles returned. Accepts a `Filters` object with `group` conditions and a `group_operator`.

pageinteger (int32)

Page number for paginated results. Defaults to 1.

Default 1

per_pageinteger (int32)

Maximum number of profiles to return per page. Minimum 1, maximum 200. Defaults to 200.

Default 200

Response

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

profilesarray<object>

List of profiles returned for this page (up to 200 entries).

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>12 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).

infooneOf

Pagination and license usage information for the profiles list response.

json

{
  "profiles": [
    {
      "api_name": "Team_User",
      "id": "4832675000000850800",
      "created_time": null,
      "modified_time": null,
      "name": "Administrator",
      "display_label": "string",
      "custom": false,
      "type": "private_profile",
      "modified_by": null,
      "description": "string",
      "created_by": null,
      "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
        }
      ]
    }
  ],
  "info": null
}

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

Was this page helpful?