Get a specific predefined action group

Returns one predefined action group, including action_ids — the templates that currently belong to it, resolved live. Passing a plain predefined action's ID here returns not-found.

Path parameters

Name	Type	Description
`predefined_action_group_id` req	string	Predefined Action Group ID

Responses

200 OK

statusintegerint32
Response code
messagestring
Response message
timestampintegerunix-timestamp
Response time
dataobject
object 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

GET /predefined_action_groups/{predefined_action_group_id}

curl "https://app.onepagecrm.com/api/v3/predefined_action_groups/{predefined_action_group_id}" \
  -u $user_id:$api_key

200 example response

{
  "status": 0,
  "message": "OK",
  "timestamp": 1528373119,
  "data": {
    "predefined_action_group": {
      "id": "5c79510e9007ba3f7519e820",
      "text": "Follow-up sequence",
      "position": 0,
      "action_ids": [
        "5acddaa7d556733c507ff405",
        "5acddaa7d556733c507ff406"
      ]
    }
  }
}