Groups

Groups cannot be modified using the API but you can retrieve a list of all groups containing the group_id which you can use as a reference when creating and updating People.

Example Request

GET /api/3/groups

Example Response

[
    {
        "id": 6834,
        "name": "Staff",
        "notes": null,
        "global_across_sites": false,
        "created_at": "2015-07-07T10:56:18+01:00",
        "updated_at": "2021-07-07T10:56:18+01:00"
    },
    {
        "id": 9345,
        "name": "Security & Maintenance",
        "notes": null,
        "global_across_sites": false,
        "created_at": "2016-05-04T14:40:45+01:00",
        "updated_at": "2021-05-04T14:40:45+01:00"
    },
    {
        "id": 9347,
        "name": "Members",
        "notes": null,
        "global_across_sites": false,
        "created_at": "2016-05-04T14:40:48+01:00",
        "updated_at": "2021-05-04T14:40:48+01:00"
    }
]