> ## 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 actions

> Retrieve the actions you can apply in a shipping rule. The accepted values for each action are omitted.

<Info>
  OAuth2 scopes required: `read:shipping-rule`. See [Scopes for OAuth apps](/api/v3/scopes).
</Info>


## OpenAPI

````yaml /.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/actions
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/actions:
    get:
      tags:
        - Possibilities
      summary: Retrieve a list of available actions
      description: >-
        Retrieve the actions you can apply in a shipping rule. The accepted
        values for each action are omitted.
      operationId: sc-public-v3-shipping-rules-list-actions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionsListResponse'
      security:
        - HTTPBasicAuth: []
        - OAuth2ClientCreds:
            - read:shipping-rule
components:
  schemas:
    ActionsListResponse:
      title: ActionsListResponse
      type: object
      description: The actions available for building rules.
      properties:
        actions:
          type: array
          default: []
          description: Available actions (metadata only, no value tables).
          items:
            $ref: '#/components/schemas/ActionConfig'
    ActionConfig:
      title: ActionConfig
      type: object
      description: Action metadata without the (potentially large) value table.
      properties:
        identifier:
          type: string
          description: Stable identifier for the action; use this in action payloads.
          example: set_insurance
        name:
          type: string
          description: Name of the action.
          example: Set insurance
        type:
          type: string
          description: Value type of the action — "SELECT", "TEXT", "NUMBER", …
          example: NUMBER
        help_text:
          type: string
          default: ''
          description: Optional explanatory text shown next to the action in the UI.
        trigger_update:
          type: boolean
          default: false
          description: >-
            If true, selecting this action should re-fetch dependent
            possibilities.
      required:
        - identifier
        - name
        - type
  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:
            read:analytics: View your shipping analytics
            read:audit-log: View your account's audit log
            read:brand: View your brands
            write:brand: Manage your brands
            write:carrier: Configure carriers and contracts
            read:checkout: View your dynamic checkout configurations and templates
            read:event-subscription: View your event subscriptions
            write:event-subscription: Create and manage your event subscriptions
            read:integration: View your integrations
            write:integration: Connect and manage integrations
            read:invoice: View your invoices
            read:notification: View your notifications
            write:notification: Manage your notifications
            read:operational-settings: >-
              View your warehouses, shipping lanes, and other operational
              settings
            write:operational-settings: >-
              Manage your warehouses, shipping lanes, and other operational
              settings
            read:order: View your orders
            write:order: Import and process your orders
            read:organization: View organization settings
            write:organization: Change organization settings
            read:parcel: View your shipments and their tracking status
            write:parcel: Create, announce, and cancel shipments
            read:pickup: View carrier pickups and the options available for scheduling them
            write:pickup: Schedule and manage carrier pickups
            read:price: View shipping prices
            write:product: Manage your product catalog
            read:return: View your returns
            write:return: Create and manage returns
            read:return-settings: View your return settings
            write:return-settings: Configure your return settings
            read:service-point: View carrier service points
            read:shipping-method: View shipping methods, products and prices
            read:shipping-rule: View your shipping rules
            write:shipping-rule: Create and manage shipping rules
            read:support-ticket: View your support tickets
            write:support-ticket: Manage your support tickets
            read:tracking-message: View your tracking notifications
            write:tracking-message: Manage your tracking notifications
            read:tracking-page: View your tracking page
            write:tracking-page: Customize your tracking page
            read:user: Read your basic account information

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.