Skip to content

List and search groups

List all groups:

GET /api/v2/groups.json

Example of response:

{
    "next_url": null,
    "groups": [{
        “group_id”:          “546340bf-8b47-21e4-95a4-e03f497dbd55”,
        “tenant_id”:         “156340bf-8b47-21e4-95a4-e03f497dbd44”,
        “name”:              “Sales Department”
    },{
        “group_id”:          “e011c408-f288-11e4-9b73-e03f497dbdff”,
        “tenant_id”:         “156340bf-8b47-21e4-95a4-e03f497dbd44”,
        “name”:              “Supervisors”
    }]
}

See also Paging through collections

Search groups:

  • Search by group name

    GET /api/v2/groups.json?search_term=supervisors

  • Search by tenant id

    GET /api/v2/groups.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff

  • Search by multiple parameters (tenant_id + search_term)

    GET /api/v2/groups.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff&search_term=supervisors