> ## Documentation Index
> Fetch the complete documentation index at: https://sendcloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a list of available operators

> Retrieve the operators you can use to compare a property to a value when building a rule condition.



## OpenAPI

````yaml /.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/operators
openapi: 3.1.0
info:
  title: Shipping Rules [BETA]
  version: 3.0.0
  description: >-
    The Sendcloud Shipping Rules API lets you automate how shipments are
    handled. A shipping rule applies one or more actions to a shipment whenever
    the shipment matches the rule's conditions, so you can set shipping methods,
    add insurance, or update other properties without manual work.
  contact:
    name: Sendcloud API Support
    url: https://www.sendcloud.dev
    email: contact@sendcloud.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://panel.sendcloud.sc/api/v3
    description: Sendcloud Production
security: []
tags:
  - name: Rules
    description: Create and manage the shipping rules that are applied to your shipments.
  - name: Possibilities
    description: >-
      Look up the properties, operators, and actions available to build shipping
      rules.
paths:
  /shipping-rules/operators:
    get:
      tags:
        - Possibilities
      summary: Retrieve a list of available operators
      description: >-
        Retrieve the operators you can use to compare a property to a value when
        building a rule condition.
      operationId: sc-public-v3-shipping-rules-list-operators
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperatorsListResponse'
      security:
        - HTTPBasicAuth: []
        - OAuth2ClientCreds: []
components:
  schemas:
    OperatorsListResponse:
      title: OperatorsListResponse
      type: object
      description: All operators available for building conditions.
      properties:
        operators:
          type: array
          default: []
          description: All operators with their intrinsic capabilities.
          items:
            $ref: '#/components/schemas/OperatorConfig'
    OperatorConfig:
      title: OperatorConfig
      type: object
      description: An operator usable in a rule condition.
      properties:
        identifier:
          type: string
          description: Stable identifier for the operator; use this in condition payloads.
          example: greater_than
        name:
          type: string
          description: Name of the operator.
          example: Greater than
        multiple:
          type: boolean
          default: false
          description: >-
            In `/shipping-rules/operators` this is the operator's intrinsic
            capability. Inside a property's `operators` list it is precomputed
            as `property.multiple AND operator.multiple` (effective capability
            for that property/operator pair).
        unary:
          type: boolean
          default: false
          description: If true, `compare_to` is omitted in conditions using this operator.
        help_text:
          type: string
          default: ''
          description: Optional explanatory text shown next to the operator in the UI.
      required:
        - identifier
        - name
  securitySchemes:
    HTTPBasicAuth:
      type: http
      description: >-
        Basic Authentication using API key and secrets is currently the main
        authentication mechanism.
      scheme: basic
    OAuth2ClientCreds:
      type: oauth2
      description: >-
        OAuth2 is a standardized protocol for authorization that allows users to
        share their private resources stored on one site with another site
        without having to provide their credentials. OAuth2 Client Credentials
        Grant workflow. This workflow is typically used for server-to-server
        interactions that require authorization to access specific resources.
      flows:
        clientCredentials:
          tokenUrl: https://account.sendcloud.com/oauth2/token/
          scopes:
            api: Default OAuth scope required to access Sendcloud API.

````