API Reference

Retrieves Group Action Fields

This call retrieves all of the fields and information specifically configured to an action. This will also be useful to note when utilizing the perform action API.

Using the perform action API is preferred when updating records as reporting and logging is more in-depth and can be used to pull reports in a manner that is generally preferred.

Sample Response

{
    "fields": [
        {
            "id": 2985215,
            "name": "Logged By",
            "key": "field_1",
            "type": "UserStampField",
            "is_only_embedded": false,
            "entity_id": null,
            "is_required": false,
            "is_open_field": true
        },
        {
            "id": 2985216,
            "name": "Pick Up Date (action)",
            "key": "field_2",
            "type": "DateTimeStampField",
            "is_only_embedded": false,
            "entity_id": null,
            "is_required": false,
            "is_open_field": true
        },
        {
            "id": 2985217,
            "name": "Time",
            "key": "field_5",
            "type": "DateDurationField",
            "is_only_embedded": false,
            "entity_id": null,
            "is_required": false,
            "is_open_field": true
        },
        {
            "id": 2985218,
            "name": "Total",
            "key": "field_6",
            "type": "NumericCalculationField",
            "is_only_embedded": false,
            "entity_id": null,
            "is_required": false,
            "is_open_field": 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!