Get all roles

GET/settings/roles

Use it in a workflow

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

Fields

baseUrlstring

The API host this action calls. Override to point at a different environment.

Default "/crm/v8"

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

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

rolesarray<object>

Represents the list of CRM roles returned in the response.

display_labelstringrequired

Represents the display label of the role as shown in the Zoho CRM user interface.

forecast_managerobject | nullrequired2 fields

Represents the forecast manager assigned to this role.

reporting_toobject | nullrequired2 fields

Represents the parent role to which this role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.

api_namestring

Represents the API name identifier for the role, used to reference the role programmatically.

share_with_peersbooleanrequired

Indicates whether users assigned to this role can share records with users in peer roles at the same level. Possible values: **true** - Users assigned to this role can share records with peer role users. **false** - Users assigned to this role cannot share records with peer role users.

descriptionstring | nullrequired

Represents the description of the role, providing additional context about its purpose and responsibilities.

idstringrequired

Represents the unique ID of the role.

namestringrequired

Represents the display name of the role.

created_by__sobject | nullrequired2 fields

Represents the user who created this role.

modified_by__sobject | nullrequired2 fields

Represents the user who last modified this role.

modified_time__sstring | nullrequired

Represents the timestamp at which the role was last modified.

created_time__sstring | nullrequired

Represents the timestamp indicating when the role was added to the organization.

json

{
  "roles": [
    {
      "display_label": "string",
      "forecast_manager": {
        "id": "string",
        "name": "string"
      },
      "reporting_to": {
        "id": "string",
        "name": "string"
      },
      "share_with_peers": false,
      "description": "string",
      "id": "string",
      "name": "string",
      "created_by__s": {
        "name": "string",
        "id": "string"
      },
      "modified_by__s": {
        "name": "string",
        "id": "string"
      },
      "modified_time__s": "2025-01-01T00:00:00Z",
      "created_time__s": "2025-01-01T00:00:00Z",
      "api_name": "string"
    }
  ]
}

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

Was this page helpful?