API Reference

Retrieves Group Action Fields

This call provides a list of actions and the configuration of the actions in a group. You will need this call and the field call information when performing an action via API.

Sample Response

{
    "actions": [
        {
            "id": 238309,
            "name": "Deliver",
            "type": "DefaultAction",
            "key": "deliver",
            "account_id": 21040,
            "entity_id": 139259,
            "has_all_entities": true,
            "has_all_statuses": true,
            "auto_return_linked_action": false,
            "fields_counter": 4,
            "is_default": false,
            "is_returnable": false,
            "is_auto_returnable": false,
            "allow_attachment_on_open": false,
            "allow_attachment_on_return": false,
            "perform_on_not_returned": true,
            "created_at": "2021-05-25T13:53:03.000Z",
            "updated_at": "2021-05-25T13:53:03.000Z",
            "ordering": 0,
            "track_gps": true,
            "return_name": "",
            "change_return_name": false,
            "deactivate_depreciation": false,
            "is_system": false,
            "feature_id": 0,
            "is_creating_entity_objects": false,
            "on_web_perform_group_action_before_scan_records": "scan_first",
            "on_mobile_perform_group_action_before_scan_records": "scan_first",
            "is_active": true
        },
        {
            "id": 238310,
            "name": "Pick Up",
            "type": "DefaultAction",
            "key": "pick_up",
            "account_id": 21040,
            "entity_id": 139259,
            "has_all_entities": true,
            "has_all_statuses": true,
            "auto_return_linked_action": false,
            "fields_counter": 10,
            "is_default": false,
            "is_returnable": false,
            "is_auto_returnable": false,
            "allow_attachment_on_open": false,
            "allow_attachment_on_return": false,
            "perform_on_not_returned": true,
            "created_at": "2021-05-25T13:53:03.000Z",
            "updated_at": "2021-05-25T13:53:03.000Z",
            "ordering": 0,
            "track_gps": true,
            "return_name": "",
            "change_return_name": false,
            "deactivate_depreciation": false,
            "is_system": false,
            "feature_id": 0,
            "is_creating_entity_objects": false,
            "on_web_perform_group_action_before_scan_records": "scan_first",
            "on_mobile_perform_group_action_before_scan_records": "scan_first",
            "is_active": true
        }
    ]
}

Parameters

KeyDescription
group_idgroup id for the selected group

Authentication

KeyDescription
AuthorizationYour Bearer token.
Language
Click Try It! to start a request and see the response here!