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

# Get actions

> Get actions



## OpenAPI

````yaml /src/autogen/incoming-actions-openapi3.0.yaml get /actions
openapi: 3.1.0
info:
  description: >-
    This OpenAPI 3.1 specification describes the public API of the Qomon
    platform. It is generated from the code and serves both as documentation for
    API consumers and as a contract for future development.
  title: Qomon API Reference
  version: 0.0.1
servers:
  - description: Production
    url: https://incoming.qomon.app
security:
  - bearerAuth: []
tags:
  - description: Retrieve action aggregations for the current space.
    name: Actions
paths:
  /actions:
    get:
      tags:
        - Actions
      summary: Get actions
      description: Get actions
      operationId: list-actions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusEnvelopeListActionsData'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
components:
  schemas:
    StatusEnvelopeListActionsData:
      additionalProperties: true
      properties:
        data:
          $ref: '#/components/schemas/ListActionsData'
        status:
          description: Operation result.
          examples:
            - success
          type: string
      required:
        - status
        - data
      type: object
    ErrorModel:
      additionalProperties: true
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ListActionsData:
      additionalProperties: true
      properties:
        ActionsAggreg:
          items:
            $ref: '#/components/schemas/ActionAggreg'
          type:
            - array
            - 'null'
      required:
        - ActionsAggreg
      type: object
    ErrorDetail:
      additionalProperties: true
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    ActionAggreg:
      additionalProperties: true
      properties:
        Action:
          $ref: '#/components/schemas/Action'
        NbContacts:
          format: int64
          type: integer
        NbVisites:
          format: int64
          type: integer
        NbVisitesDeclared:
          format: int64
          type: integer
      type: object
    Action:
      additionalProperties: true
      properties:
        Addresses:
          items:
            $ref: '#/components/schemas/Address'
          type:
            - array
            - 'null'
        CreatedAt:
          format: date-time
          type: string
        Forms:
          items:
            $ref: '#/components/schemas/Form'
          type:
            - array
            - 'null'
        ID:
          format: int64
          minimum: 0
          type: integer
        Teams:
          items:
            $ref: '#/components/schemas/ActionTeam'
          type:
            - array
            - 'null'
        UpdatedAt:
          format: date-time
          type: string
        Users:
          items:
            $ref: '#/components/schemas/ActionUserWithActive'
          type:
            - array
            - 'null'
        advanced_search:
          description: Advanced search stringified.
        broadcast_link:
          type: string
        cover_img: {}
        created_by:
          format: int64
          minimum: 0
          type: integer
        created_by_details:
          $ref: '#/components/schemas/ActionCreatedByDetails'
        end:
          format: date-time
          type: string
        featured:
          type: boolean
        form_state:
          type: string
        goal:
          format: int64
          type: integer
        goal_forms:
          format: int64
          type: integer
        gotv_abstention_tag:
          type: string
        gotv_not_voted_tag:
          type: string
        gotv_voted_tag:
          type: string
        group_id:
          format: int64
          minimum: 0
          type: integer
        hide_broadcast_link:
          type: boolean
        leaders:
          items:
            $ref: '#/components/schemas/ActionUserWithActive'
          type:
            - array
            - 'null'
        links:
          items:
            type: string
          type:
            - array
            - 'null'
        maximum_capacity:
          format: int64
          minimum: 0
          type: integer
        name:
          description: Name of the action.
          examples:
            - Let's mobilize
          type: string
        pitch:
          description: Pitch of the action.
          type: string
        polygon:
          description: Polygon stringified.
          type: string
        promote_sharing:
          type: boolean
        public:
          type: boolean
        registration_link:
          type: string
        restricted:
          type: boolean
        site_id:
          type: string
        site_slug:
          type: string
        site_state:
          type: string
        start:
          format: date-time
          type: string
        status:
          enum:
            - todo
            - archived
            - finished
          type: string
        survey_id:
          format: int64
          minimum: 0
          type: integer
        time_zone:
          type: string
        type_data:
          description: Action type.
          enum:
            - canvassing
            - event
            - mail
            - call
            - static
            - other
            - leaflet
            - sharing
            - reporting
            - challenge
            - gotvcanvassing
            - gotvcalling
          type: string
      required:
        - ID
      type: object
    Address:
      additionalProperties: true
      properties:
        addition:
          description: Additional address info.
          type: string
        building:
          description: Building name or identifier.
          type: string
        building_type:
          description: Type of building.
          enum:
            - house
            - apartment
            - office
            - other
          type: string
        city:
          description: City name.
          examples:
            - Paris
          type: string
        country:
          description: Country.
          examples:
            - France
          type: string
        county:
          description: County or department.
          type: string
        door:
          description: Door or apartment identifier.
          type: string
        floor:
          description: Floor number.
          type: string
        housenumber:
          description: Street number.
          examples:
            - '12'
          type: string
        id:
          description: Unique identifier of the address.
          examples:
            - 7
          format: int64
          minimum: 0
          readOnly: true
          type: integer
        infos:
          description: Additional address information.
          type: string
        latitude:
          description: WGS-84 latitude.
          examples:
            - '48.8606'
          readOnly: true
          type: string
        location:
          description: Geocoded location string.
          examples:
            - 48.8606,2.3376
          readOnly: true
          type: string
        longitude:
          description: WGS-84 longitude.
          examples:
            - '2.3376'
          readOnly: true
          type: string
        pollingstation:
          type: string
        postalcode:
          description: Postal / ZIP code.
          examples:
            - '75001'
          type: string
        score:
          description: Address geocoding accuracy score 0-1
          format: int64
          readOnly: true
          type: integer
        state:
          description: State or region.
          type: string
        street:
          description: Street name.
          examples:
            - Rue de Rivoli
          type: string
      type: object
    Form:
      additionalProperties: true
      properties:
        CreatedAt:
          description: Timestamp when the form was created.
          format: date-time
          readOnly: true
          type: string
        UpdatedAt:
          description: Timestamp when the form was last updated.
          format: date-time
          readOnly: true
          type: string
        group_id:
          description: IDs of groups the form belongs to.
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
        id:
          format: int64
          minimum: 0
          type: integer
        label:
          description: Label of the form.
          examples:
            - Volunteer registration
          type: string
        refvalues:
          description: >-
            A list of possible answers or predefined values associated with the
            form. These can be simple options or a range of values, depending on
            the form type.
          items:
            $ref: '#/components/schemas/Refvalue'
          type:
            - array
            - 'null'
        type:
          description: The format of the form.
          enum:
            - text
            - radio
            - numeric
            - checkbox
            - date
            - range
            - signature
            - photos
          examples:
            - radio
          type: string
      required:
        - id
        - label
        - type
        - refvalues
      type: object
    ActionTeam:
      additionalProperties: true
      properties:
        address:
          $ref: '#/components/schemas/Address'
        created_at:
          format: date-time
          type: string
        description:
          description: Free-form description.
          type: string
        hide_users:
          description: When true, the team's users list is hidden to non-members.
          type: boolean
        id:
          description: Team ID.
          examples:
            - 101
          format: int64
          minimum: 0
          type: integer
        leaders:
          items:
            $ref: '#/components/schemas/UserInfo'
          type:
            - array
            - 'null'
        name:
          description: Team display name.
          examples:
            - Team Number1
          type: string
        private:
          description: When true, the team is only visible to its members.
          type: boolean
        updated_at:
          format: date-time
          type: string
        userswithactive:
          items:
            $ref: '#/components/schemas/ActionUserWithActive'
          type:
            - array
            - 'null'
      required:
        - id
        - name
      type: object
    ActionUserWithActive:
      additionalProperties: true
      properties:
        CreatedAt:
          description: Timestamp when the user was created.
          format: date-time
          readOnly: true
          type: string
        UpdatedAt:
          description: Timestamp when the user was last updated.
          format: date-time
          readOnly: true
          type: string
        active:
          examples:
            - true
          type:
            - boolean
            - 'null'
        address:
          description: Street address.
          examples:
            - 1 rue de la paix
          type: string
        avatar:
          description: Avatar URL.
          examples:
            - https://example.com/avatar.png
          format: uri
          type: string
        birthdate:
          description: Birthdate.
          format: date-time
          type: string
        city:
          description: City.
          examples:
            - Paris
          type: string
        created:
          description: Legacy creation timestamp returned by the upstream service.
          format: date-time
          readOnly: true
          type: string
        firstname:
          description: First name.
          examples:
            - John
          type: string
        group_id:
          description: IDs of groups the user belongs to.
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
        id:
          description: Unique identifier of the user.
          examples:
            - 101
          format: int64
          readOnly: true
          type: integer
        locale:
          description: Locale language.
          examples:
            - en
          type: string
        location:
          description: Geographic position as lat,lon string.
          examples:
            - 1.826483,-1.549486
          type: string
        mail:
          description: Email address.
          examples:
            - john.doe@example.com
          format: email
          type: string
        phone:
          description: Phone number.
          examples:
            - '0123456789'
          type: string
        postal:
          description: Postal code.
          examples:
            - '75000'
          type: string
        status:
          description: >-
            User status. Comma-separated list of strings. Values:
            'available_week_morning,available_week_night,available_holidays,available_weekend,not_set'.
          examples:
            - available_week_morning,available_weekend
          type: string
        surname:
          description: Last name.
          examples:
            - Doe
          type: string
        two_factor_enable:
          description: Indicates if two-factor authentication is enabled.
          type: boolean
        two_factor_method:
          description: Two-factor authentication method.
          enum:
            - email
            - totp
          type: string
      required:
        - active
      type: object
    ActionCreatedByDetails:
      additionalProperties: true
      properties:
        avatar:
          type: string
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        phone:
          type: string
        status:
          type: string
      required:
        - first_name
        - last_name
        - status
        - phone
        - email
        - avatar
      type: object
    Refvalue:
      additionalProperties: true
      properties:
        CreatedAt:
          description: Timestamp when the refvalue was created.
          format: date-time
          readOnly: true
          type: string
        UpdatedAt:
          description: Timestamp when the refvalue was last updated.
          format: date-time
          readOnly: true
          type: string
        form_id:
          description: ID of the form to which this refvalue belongs.
          format: int64
          minimum: 0
          type: integer
        id:
          description: Unique identifier of the refvalue.
          format: int64
          minimum: 0
          type: integer
        label:
          description: Label of the refvalue.
          examples:
            - 'Yes'
          type: string
        max:
          description: Maximum value for numeric or range forms.
          examples:
            - 5
          format: int64
          minimum: 0
          type: integer
        min:
          description: Minimum value for numeric or range forms.
          examples:
            - 1
          format: int64
          minimum: 0
          type: integer
        order:
          description: The order in which the refvalues should be displayed for selection.
          examples:
            - 1
          format: int64
          minimum: 0
          type: integer
        step:
          description: >-
            Step value for numeric or range forms, indicating the increments
            between valid values.
          examples:
            - 1
          format: int64
          minimum: 0
          type: integer
        value:
          description: >-
            The actual value associated with the refvalue. This is what gets
            stored when the form is submitted.
          examples:
            - 'yes'
          type: string
      required:
        - id
        - form_id
        - label
        - value
      type: object
    UserInfo:
      additionalProperties: true
      properties:
        CreatedAt:
          description: Timestamp when the user was created.
          format: date-time
          readOnly: true
          type: string
        UpdatedAt:
          description: Timestamp when the user was last updated.
          format: date-time
          readOnly: true
          type: string
        address:
          description: Street address.
          examples:
            - 1 rue de la paix
          type: string
        avatar:
          description: Avatar URL.
          examples:
            - https://example.com/avatar.png
          format: uri
          type: string
        birthdate:
          description: Birthdate.
          format: date-time
          type: string
        city:
          description: City.
          examples:
            - Paris
          type: string
        created:
          description: Legacy creation timestamp returned by the upstream service.
          format: date-time
          readOnly: true
          type: string
        firstname:
          description: First name.
          examples:
            - John
          type: string
        group_id:
          description: IDs of groups the user belongs to.
          items:
            format: int64
            type: integer
          type:
            - array
            - 'null'
        id:
          description: Unique identifier of the user.
          examples:
            - 101
          format: int64
          readOnly: true
          type: integer
        locale:
          description: Locale language.
          examples:
            - en
          type: string
        location:
          description: Geographic position as lat,lon string.
          examples:
            - 1.826483,-1.549486
          type: string
        mail:
          description: Email address.
          examples:
            - john.doe@example.com
          format: email
          type: string
        phone:
          description: Phone number.
          examples:
            - '0123456789'
          type: string
        postal:
          description: Postal code.
          examples:
            - '75000'
          type: string
        status:
          description: >-
            User status. Comma-separated list of strings. Values:
            'available_week_morning,available_week_night,available_holidays,available_weekend,not_set'.
          examples:
            - available_week_morning,available_weekend
          type: string
        surname:
          description: Last name.
          examples:
            - Doe
          type: string
        two_factor_enable:
          description: Indicates if two-factor authentication is enabled.
          type: boolean
        two_factor_method:
          description: Two-factor authentication method.
          enum:
            - email
            - totp
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: opaque
      description: >-
        OAuth2 access token. Pass the token in the Authorization header as
        `Bearer <token>`. The token is looked up in Redis to resolve the caller
        identity.
      scheme: bearer
      type: http

````