> ## Documentation Index > Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt > Use this file to discover all available pages before exploring further. # ListRules > Retrieves a list of rules. ## OpenAPI ````yaml /openapi.json get /api/v1/rules:list openapi: 3.0.0 info: title: Sift API version: '1.0' servers: - url: https://api.siftstack.com description: Production - url: https://gov.api.siftstack.com description: Gov security: - BearerAuth: [] tags: - name: TagService description: Service to programmatically interact with [tags](/glossary#tag). - name: CampaignService - name: ProtobufDescriptorService description: >- Service to programmatically interact with protobuf descriptors used for protobuf ingestion. externalDocs: description: Read more about what protobuf ingestion. url: /ingestion/protobuf_ingestion - name: AnnotationLogService description: >- Service to programmatically interact with [annotation logs](/glossary#annotation). externalDocs: description: Read more about annotations. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265486685 - name: MetadataService - name: DlqErrorsService - name: RuleService description: Service to programmatically interact with rules. externalDocs: description: Read more about what rules are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421102 - name: WebhookService - name: UserDefinedFunctionService - name: ReportTemplateService - name: RemoteFileService - name: PingService - name: FamilyService description: Service to programmatically interact with family configurations. - name: ExternalSyncService - name: ReportService - name: NotificationService description: Service to programmatically interact with in-app notifications. - name: ChannelSchemaService description: Service to programmatically interact with channel schemas - name: IngestService - name: UserService description: Service to programmatically interact with user objects. - name: TestReportService description: Service to manage test reports - name: PrincipalAttributeService description: Service to manage ABAC principal attributes. - name: ChannelService description: Service to programmatically interact with [channels](/glossary#channel). externalDocs: description: Read more about what channels are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265453943 - name: DataImportService - name: ExportService - name: PolicyService description: Service to manage ABAC policies. - name: ApiKeyService - name: CommentService description: >- Service to programmatically interact with comments attached to resources in the platform. - name: JobService - name: UserGroupService - name: ResourceAttributeService description: Service to manage ABAC resource attributes (entity attributes). - name: AutomationService - name: ViewService description: Service to programmatically interact with views. externalDocs: description: Read more about what views are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/298188809 - name: UnitService - name: DocsService - name: RoleService - name: SavedSearchService - name: RuleEvaluationService description: Service to evaluate rules. externalDocs: description: Read more about what rules are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421102 - name: RunService description: Service to programmatically interact with [runs](/glossary#run). externalDocs: description: Read more about what runs are. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265454053 - name: PanelConfigurationService description: Service to programmatically interact with panel configurations. - name: IngestionConfigService description: >- Service to programmatically interact with [ingestion configs](/glossary#ingestion-config). externalDocs: description: Read more about what ingestion configs are. url: /ingestion/creating-amend-ingestion-config - name: CalculatedChannelService - name: CalculatedChannelsService description: Service to programmatically interact with calculated channels. externalDocs: description: Read more about calculated channels. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265421153 - name: AnnotationService description: Service to programmatically interact with annotations. externalDocs: description: Read more about annotations. url: >- https://customer.support.siftstack.com/servicedesk/customer/portal/2/article/265486685 - name: DataService description: Service to query data - name: MeService - name: AssetService description: Service to programmatically interact with [assets](/glossary#asset). externalDocs: description: Read more about what assets are. url: /data-model paths: /api/v1/rules:list: get: tags: - RuleService summary: ListRules description: Retrieves a list of rules. operationId: RuleService_ListRules parameters: - name: pageSize description: >- The maximum number of Rules to return. The service may return fewer than this value. If unspecified, at most 50 Rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. in: query required: false schema: type: integer format: int64 - name: pageToken description: >- A page token, received from a previous `ListRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRules` must match the call that provided the page token. in: query required: false schema: type: string - name: filter description: >- A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `rule_id`, `client_key`, `name`, `description`, `is_external`, `asset_id`, `tag_id`, `created_date`, `created_by_user_id`, `metadata`, `modified_date`, `modified_by_user_id`, `deleted_date`, `is_archived`, `archived_date`, and `is_live_evaluation_enabled`. Metadata can be used in filters by using `metadata.{metadata_key_name}` as the field name. Folder membership is filterable via the `folders` and `activeFolders` fields. Both contain the ids of the folders the rule belongs to; `activeFolders` excludes archived folders. Use `"" in folders` to return rules in the given folder, and `size(activeFolders) == 0` to return uncategorized rules (rules whose only memberships are in archived folders count as uncategorized). For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). Optional. in: query required: false schema: type: string - name: orderBy description: >- How to order the retrieved Rules. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are `created_date` and `modified_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). in: query required: false schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v1ListRulesResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/rpcStatus' components: schemas: v1ListRulesResponse: type: object properties: rules: type: array items: $ref: '#/components/schemas/v1Rule' nextPageToken: type: string required: - rules rpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' v1Rule: type: object properties: ruleId: type: string assetId: type: string name: type: string description: type: string isEnabled: type: boolean createdDate: type: string format: date-time modifiedDate: type: string format: date-time createdByUserId: type: string modifiedByUserId: type: string organizationId: type: string conditions: type: array items: $ref: '#/components/schemas/v1RuleCondition' ruleVersion: $ref: '#/components/schemas/v1RuleVersion' clientKey: type: string description: >- client_key is a client provided identifier for the rule. It is immutable after rule creation. assetConfiguration: $ref: '#/components/schemas/v1RuleAssetConfiguration' contextualChannels: $ref: '#/components/schemas/v1ContextualChannels' deletedDate: type: string format: date-time isExternal: type: boolean metadata: type: array items: $ref: '#/components/schemas/v1MetadataValue' archivedDate: type: string format: date-time title: archived_date indicates when the rule was archived isArchived: type: boolean title: is_archived is inferred from when archived_date is not null isLiveEvaluationEnabled: type: boolean description: >- If `true`, this rule will be evaluated on live data; if `false`, live rule evaluation is disabled (the rule remains usable for report generation). Note: this value is the server's effective state, not necessarily what was requested. A rule saved via `BatchUpdateRulesRequest.override_expression_validation = true` whose UDF inlining fails (e.g. type resolution exhausted; see error returned by `BatchUpdateRules`) is forced to `is_live_evaluation_enabled = false` even when the caller requested `true`. To recover after the underlying issue is fixed (channels populated, expression simplified, etc.), reissue an `UpdateRule` / `BatchUpdateRules` request that explicitly sets `is_live_evaluation_enabled = true`. currentVersionId: type: string description: >- The current version of the rule. This is may be different from the rule_version.version if the rule has been updated since the rule_version was created. folderIds: type: array items: type: string description: Ids of the folders this rule belongs to. required: - ruleId - assetId - name - description - isEnabled - createdDate - modifiedDate - createdByUserId - modifiedByUserId - organizationId - conditions - ruleVersion - assetConfiguration - contextualChannels - isExternal - metadata - isArchived - currentVersionId protobufAny: type: object properties: '@type': type: string description: >- A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. additionalProperties: {} description: >- `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } v1RuleCondition: type: object properties: ruleConditionId: type: string ruleId: type: string expression: $ref: '#/components/schemas/v1RuleConditionExpression' createdDate: type: string format: date-time modifiedDate: type: string format: date-time createdByUserId: type: string modifiedByUserId: type: string actions: type: array items: $ref: '#/components/schemas/v1RuleAction' ruleConditionVersionId: type: string required: - ruleConditionId - ruleId - expression - createdDate - modifiedDate - createdByUserId - modifiedByUserId - actions - ruleConditionVersionId v1RuleVersion: type: object properties: ruleId: type: string ruleVersionId: type: string version: type: string createdDate: type: string format: date-time createdByUserId: type: string versionNotes: type: string generatedChangeMessage: type: string deletedDate: type: string format: date-time archivedDate: type: string format: date-time title: archived_date indicates when the rule version was archived isArchived: type: boolean title: is_archived is inferred from when archived_date is not null required: - ruleId - ruleVersionId - version - createdDate - createdByUserId - versionNotes - generatedChangeMessage - isArchived v1RuleAssetConfiguration: type: object properties: assetIds: type: array items: type: string tagIds: type: array items: type: string v1ContextualChannels: type: object properties: channels: type: array items: $ref: '#/components/schemas/rulesv1ChannelReference' required: - channels v1MetadataValue: type: object properties: key: $ref: '#/components/schemas/v1MetadataKey' stringValue: type: string numberValue: type: number format: double booleanValue: type: boolean relationValue: $ref: '#/components/schemas/v1MetadataRelationValue' archivedDate: type: string format: date-time isArchived: type: boolean description: >- Whether the metadata value is archived. This is inferred from whether archived_date is set. required: - key v1RuleConditionExpression: type: object properties: singleChannelComparison: $ref: '#/components/schemas/v1SingleChannelComparisonExpression' calculatedChannel: $ref: '#/components/schemas/siftrulesv1CalculatedChannelConfig' v1RuleAction: type: object properties: ruleActionId: type: string ruleConditionId: type: string actionType: $ref: '#/components/schemas/v1ActionKind' configuration: $ref: '#/components/schemas/v1RuleActionConfiguration' createdDate: type: string format: date-time modifiedDate: type: string format: date-time createdByUserId: type: string modifiedByUserId: type: string ruleActionVersionId: type: string required: - ruleActionId - ruleConditionId - actionType - configuration - createdDate - modifiedDate - createdByUserId - modifiedByUserId - ruleActionVersionId rulesv1ChannelReference: type: object properties: name: type: string description: >- Required for native channel references. Must not be set when calculated_channel_version_id is provided. component: type: string description: >- Deprecated - use name instead. If provided, name will be joined with the component as `component.name`. Must not be set when calculated_channel_version_id is provided. calculatedChannelVersionId: type: string description: >- Reference to a calculated channel version. When set, the rule will use the calculated channel instead of looking up a native channel by name. Must not be set when name is provided. v1MetadataKey: type: object properties: name: type: string type: $ref: '#/components/schemas/v1MetadataKeyType' archivedDate: type: string format: date-time isArchived: type: boolean description: >- Whether the metadata key is archived. This is inferred from whether archived_date is set. The filter field type this key maps to, so a client can build a CEL filter against it (`metadata[""]`) and resolve its operators and functions from FilterGrammarService. Derived from `type`. required: - name - type v1MetadataRelationValue: type: object properties: resourceType: type: string resourceId: type: string required: - resourceType - resourceId v1SingleChannelComparisonExpression: type: object properties: channelComponent: type: string title: >- Deprecated - use channel_name instead. If provided, channel_component will be joined with the name as `channel_component.channel_name` channelName: type: string comparator: $ref: '#/components/schemas/v1ConditionComparator' double: type: number format: double string: type: string lastValue: $ref: '#/components/schemas/v1LastValueThreshold' description: Deprecated - use CalculatedChannelConfig. required: - channelComponent - channelName - comparator siftrulesv1CalculatedChannelConfig: type: object properties: channelReferences: type: object additionalProperties: $ref: '#/components/schemas/rulesv1ChannelReference' expression: type: string functionDependencies: type: array items: $ref: '#/components/schemas/v1FunctionDependency' description: >- This will be ignored in requests and will be generated automatically. calculatedChannelDependencies: type: array items: $ref: '#/components/schemas/typev1CalculatedChannelDependency' description: >- This will be ignored in requests and will be generated automatically. Tracks which calculated channel versions this rule depends on. readOnly: true required: - channelReferences - expression v1ActionKind: type: string enum: - ACTION_KIND_UNSPECIFIED - NOTIFICATION - ANNOTATION - WEBHOOK default: ACTION_KIND_UNSPECIFIED v1RuleActionConfiguration: type: object properties: notification: $ref: '#/components/schemas/v1NotificationActionConfiguration' annotation: $ref: '#/components/schemas/v1AnnotationActionConfiguration' webhook: $ref: '#/components/schemas/v1WebhookActionConfiguration' v1MetadataKeyType: type: string enum: - METADATA_KEY_TYPE_UNSPECIFIED - METADATA_KEY_TYPE_STRING - METADATA_KEY_TYPE_NUMBER - METADATA_KEY_TYPE_BOOLEAN - METADATA_KEY_TYPE_RELATION default: METADATA_KEY_TYPE_UNSPECIFIED description: |- Metadata key type. - METADATA_KEY_TYPE_STRING: string - METADATA_KEY_TYPE_NUMBER: number - METADATA_KEY_TYPE_BOOLEAN: boolean - METADATA_KEY_TYPE_RELATION: relation — references another resource by UUID (e.g. folder membership) v1ConditionComparator: type: string enum: - CONDITION_COMPARATOR_UNSPECIFIED - LESS_THAN - LESS_THAN_OR_EQUAL - GREATER_THAN - GREATER_THAN_OR_EQUAL - EQUAL - NOT_EQUAL default: CONDITION_COMPARATOR_UNSPECIFIED v1LastValueThreshold: type: object v1FunctionDependency: type: object properties: userDefinedFunctionVersionId: type: string required: - userDefinedFunctionVersionId typev1CalculatedChannelDependency: type: object properties: calculatedChannelVersionId: type: string description: A dependency on another calculated channel. required: - calculatedChannelVersionId v1NotificationActionConfiguration: type: object properties: recipientUserIds: type: array items: type: string required: - recipientUserIds v1AnnotationActionConfiguration: type: object properties: tagIds: type: array items: type: string annotationType: $ref: '#/components/schemas/v1AnnotationType' assignedToUserId: type: string metadata: type: array items: $ref: '#/components/schemas/v1MetadataValue' required: - tagIds v1WebhookActionConfiguration: type: object properties: webhookId: type: string required: - webhookId v1AnnotationType: type: string enum: - ANNOTATION_TYPE_UNSPECIFIED - ANNOTATION_TYPE_DATA_REVIEW - ANNOTATION_TYPE_PHASE default: ANNOTATION_TYPE_UNSPECIFIED securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT ````