Automation Cloud Dedicated - Get all rules in bulk

Endpoint

GET /api/Rule/{partitionGlobalId}

Request body

[
  {
    "id": 0,
    "partitionGlobalId": "<partitionGlobalId>",
    "name": "string",
    "description": "string",
    "enabled": true,
    "definition": "string",
    "assignedGroups": [
      {
        "id": "Id",
        "name": "string",
        "type": "builtIn",
        "creationTime": "2026-01-16T19:48:18.738Z",
        "lastModificationTime": "2026-01-16T19:48:18.738Z",
        "members": [
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string",
            "firstName": "string",
            "lastName": "string",
            "jobTitle": "string",
            "companyName": "string",
            "city": "string",
            "department": "string",
            "extensionUserAttributes": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "externalId": "string",
            "isActive": true,
            "creationTime": "2026-01-16T19:48:18.738Z"
          },
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string",
            "externalId": "string"
          },
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string"
          },
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string",
            "applicationId": "string"
          }
        ]
      }
    ]
  }
][
  {
    "id": 0,
    "partitionGlobalId": "<partitionGlobalId>",
    "name": "string",
    "description": "string",
    "enabled": true,
    "definition": "string",
    "assignedGroups": [
      {
        "id": "Id",
        "name": "string",
        "type": "builtIn",
        "creationTime": "2026-01-16T19:48:18.738Z",
        "lastModificationTime": "2026-01-16T19:48:18.738Z",
        "members": [
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string",
            "firstName": "string",
            "lastName": "string",
            "jobTitle": "string",
            "companyName": "string",
            "city": "string",
            "department": "string",
            "extensionUserAttributes": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "externalId": "string",
            "isActive": true,
            "creationTime": "2026-01-16T19:48:18.738Z"
          },
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string",
            "externalId": "string"
          },
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string"
          },
          {
            "objectType": "string",
            "source": "string",
            "identifier": "string",
            "name": "string",
            "email": "string",
            "displayName": "string",
            "applicationId": "string"
          }
        ]
      }
    ]
  }
]

Request headers

--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'
--header 'Content-Type: application/json'

Parameters

Name	Type	Location	Required	Description
`partitionGlobalId`	GUID	Path	Yes	The global identifier of the organization. For steps on retrieving `partitionGlobalId`, refer to Retrieving partitionGlobalId for API use.

Responses

Note:

definition is returned as a stringified JSON object, not as a structured JSON object.
Optional fields are returned as empty strings ("") when unset (for example, description).
assignedGroups is returned as an empty array ([]) when no groups are resolved or assigned.
partitionGlobalId may be returned as the zero GUID, depending on the environment or rule scope.

[
  {
    "id": 2607,
    "partitionGlobalId": "00000000-0000-0000-0000-000000000000",
    "name": "Automation Users",
    "description": "",
    "enabled": true,
    "definition": "{\"GroupsToAssign\":[\"cdc34b5b-77d2-4ae1-9744-209d21ce557d\"],\"Conditions\":[{\"ClaimName\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress\",\"ConditionType\":\"Contains\",\"Value\":\"uipath.com\"}]}" ,
    "assignedGroups": []
  }
][
  {
    "id": 2607,
    "partitionGlobalId": "00000000-0000-0000-0000-000000000000",
    "name": "Automation Users",
    "description": "",
    "enabled": true,
    "definition": "{\"GroupsToAssign\":[\"cdc34b5b-77d2-4ae1-9744-209d21ce557d\"],\"Conditions\":[{\"ClaimName\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress\",\"ConditionType\":\"Contains\",\"Value\":\"uipath.com\"}]}" ,
    "assignedGroups": []
  }
]

Automation Cloud Dedicated API guide

Get all rules in bulk

Endpoint

Request body

Request headers

Parameters

Responses

Was this page helpful?