> ## 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 an action

> Retrieve a single action, including the full list of values it accepts, by its identifier.



## OpenAPI

````yaml /.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/actions/{identifier}
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/{identifier}:
    parameters:
      - name: identifier
        in: path
        required: true
        schema:
          type: string
          example: set_shipping_method
        description: The stable identifier of the action.
    get:
      tags:
        - Possibilities
      summary: Retrieve an action
      description: >-
        Retrieve a single action, including the full list of values it accepts,
        by its identifier.
      operationId: sc-public-v3-shipping-rules-get-action
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionDetail'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - HTTPBasicAuth: []
        - OAuth2ClientCreds: []
components:
  schemas:
    ActionDetail:
      title: ActionDetail
      type: object
      description: An action together with the full list of values it accepts.
      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.
        possibilities:
          type: array
          description: '[[key, label], …] for SELECT-typed actions; empty for free-form.'
          items:
            type: array
            items:
              type: string
      required:
        - identifier
        - name
        - type
    ErrorResponse:
      title: ErrorResponse
      type: object
      description: A standardized format for errors in JSON:API responses.
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorObject'
      required:
        - errors
    ErrorObject:
      title: Error
      type: object
      description: Error in a JSON:API error format
      properties:
        id:
          type: string
          description: A unique identifier for the error.
        links:
          type: object
          description: >-
            A set of hyperlinks that provide additional information about the
            error.
          properties:
            about:
              type: string
              description: A URL that provides additional information about the error.
        status:
          type: string
          format: int32
          description: The HTTP status code of the error.
          minLength: 1
        code:
          type: string
          description: A unique error code for the error, in snake case format.
          minLength: 1
          enum:
            - unknown_field
            - invalid
            - forbidden
            - invalid_choice
            - min_value
            - 'null'
            - not_found
            - required
            - not_a_list
            - non_field_errors
            - authentication_failed
            - validation_error
            - parcel_announcement_error
        title:
          type: string
          description: A short, human-readable summary of the error.
          minLength: 1
        detail:
          type: string
          description: A human-readable explanation of the error.
          minLength: 1
        source:
          type: object
          description: >-
            An object that identifies the source of the error within the request
            payload.
          properties:
            pointer:
              type: string
              description: >-
                A `JSON` pointer to the location of the error within the request
                payload.
            parameter:
              type: string
              description: The name of the `query` parameter that caused the error.
            header:
              type: string
              description: The name of the `header` parameter that caused the error.
        meta:
          type: object
          description: Additional metadata about the error.
  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.

````