Skip to content

API Reference / Predefined Action Groups

GET /predefined_action_groups

Get the list of predefined action groups (for the logged API user's account)

Returns the account's predefined action groups. A group bundles two or more predefined action templates so they can all be applied to a contact in one request, each with its own due date.

Maintained by the OnePageCRM engineering team

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • predefined_action_groupsarray<object>
      array item fields →
      • predefined_action_groupobject

        A grouping of predefined actions. Useful if actions can be assigned together as part of a workflow.

        object fields →
        • idstringbson-id

          ID of the predefined action group

        • textstring

          Name of the predefined action group

        • positionintegerint32

          Position of the group in the list of predefined action groups

        • action_idsarray<string>

          List of IDs of the predefined actions in the predefined action group

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides