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

# List your actions

> The actions of your company newest first, cursor-paginated, with the budget consumed (`budget_spent`, the same number as the dashboard). The `id` is the action's code: the `action_id` of a credit. Filter by `status` (active, paused, ended). Creating or changing an action is done in the dashboard. Scope `partner.read`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/partner/actions/
openapi: 3.0.3
info:
  title: Zupy API v2
  version: 2.0.0
  description: >-
    Zupy API v2 — versioned, gateway-aware API with envelope responses, RFC 7807
    errors, and multi-auth support (JWT, API Key, Device Key).
servers:
  - url: https://api.zupy.com
    description: Production
security: []
tags:
  - name: Authentication
    description: OTP request and verification endpoints
  - name: Customers
    description: Customer management, points, history, and data operations
  - name: Loyalty Programs
    description: Loyalty program configuration and details
  - name: Rewards
    description: Loyalty reward catalog (definitions redeemed with points)
  - name: Companies
    description: Company information and loyalty configuration
  - name: Coupons
    description: >-
      Issued coupons (RewardRedemption) — both loyalty-reward redemptions and
      marketing claims
  - name: Wallet
    description: Apple Wallet pass generation and notifications
  - name: Webhooks
    description: Partner integration webhook endpoints
  - name: Webhook Management
    description: Configure and test outbound webhook delivery
  - name: Partner
    description: >-
      Issuer partner API: credit and transfer Z$ with your partner key (scopes
      `partner.read`, `partner.credit`, `partner.transfer`).
paths:
  /api/v2/partner/actions/:
    get:
      tags:
        - Partner
      summary: List your actions
      description: >-
        The actions of your company newest first, cursor-paginated, with the
        budget consumed (`budget_spent`, the same number as the dashboard). The
        `id` is the action's code: the `action_id` of a credit. Filter by
        `status` (active, paused, ended). Creating or changing an action is done
        in the dashboard. Scope `partner.read`.
      operationId: partner_actions_list
      parameters:
        - name: cursor
          required: false
          in: query
          description: The pagination cursor (the `next` or `previous` link carries it).
          schema:
            type: string
        - name: page_size
          required: false
          in: query
          description: Items per page, 1 to 100 (default 25).
          schema:
            type: integer
        - in: query
          name: status
          schema:
            type: string
            enum:
              - active
              - ended
              - paused
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPartnerActionList'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
          description: ''
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
      security:
        - apiKeyAuth: []
components:
  schemas:
    PaginatedPartnerActionList:
      type: object
      required:
        - next
        - previous
        - results
      properties:
        count:
          type: integer
          nullable: true
          example: 123
        next:
          type: string
          nullable: true
          format: uri
        previous:
          type: string
          nullable: true
          format: uri
        results:
          type: array
          items:
            $ref: '#/components/schemas/PartnerAction'
    Error:
      type: object
      description: RFC 7807 Problem Details error response.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
      required:
        - detail
        - instance
        - status
        - title
        - type
    ValidationError:
      type: object
      description: RFC 7807 error with validation errors array.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
      required:
        - detail
        - errors
        - instance
        - status
        - title
        - type
    PartnerAction:
      type: object
      description: >-
        One action of your company, with its reward (`unit_value` Z$ per unit)
        and the budget consumed. `id` is the action's code (the `action_id` of a
        credit).
      properties:
        id:
          type: integer
        name:
          type: string
        status:
          type: string
        action_type:
          $ref: '#/components/schemas/PartnerPanelActionType'
        unit_value:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
        per_user_limit:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          nullable: true
        per_user_period:
          type: string
        budget_total:
          type: string
          format: decimal
          pattern: ^-?\d{0,18}(?:\.\d{0,2})?$
          nullable: true
        budget_spent:
          type: string
          description: >-
            Z$ already credited through this action: the same number the
            dashboard shows.
          readOnly: true
        starts_at:
          type: string
          format: date-time
          nullable: true
        ends_at:
          type: string
          format: date-time
          nullable: true
      required:
        - action_type
        - budget_spent
        - budget_total
        - ends_at
        - id
        - name
        - per_user_limit
        - per_user_period
        - starts_at
        - status
        - unit_value
    FieldError:
      type: object
      description: Individual field error in a validation error response.
      properties:
        field:
          type: string
        detail:
          type: string
      required:
        - detail
        - field
    PartnerPanelActionType:
      type: object
      properties:
        code:
          type: string
        name:
          type: string
        unit:
          type: string
        category:
          type: string
      required:
        - category
        - code
        - name
        - unit
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Per-company partner API key (zupy_pk_…). Validated by Zupy against the
        company integration key hash (Story 14.x); send it on every request as
        the X-API-Key header. Scoped read-write to the owning company's data.

````

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