Contents x
    List Groups (GET)
    • 01 Aug 2023
    • 1 Minute to read
    • Contributors
      Contents

      List Groups (GET)

      • Updated on 01 Aug 2023
      • 1 Minute to read
      • Contributors
        Article Summary

        GET /v1/groups

        Get a paginated list of groups.

        Parameters:

        Property

        Data Type

        Description

        page

        Integer

        Page to start from.

        limit

        Integer

        The number of records per page.

        sort

        Object

        Map of fields and sort order. Example:
        ?sort[field1]=asc&sort[field2]=desc.

        Request Body: None

        Request Example:

        curl -X GET -H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Content-Type: application/json' 'https://api.perimeter81.com/api/rest/v1/groups?page=1&limit=1'

        Response Body:

        Status Code

        Message/Response Body

        Description

        200

        		GroupList

        Success. A list of groups is returned.

        Response Example (200):

        {
  "data":[
    {
      "tenantId":"<TENANT_NAME>",
      "name":"<GROUP_NAME>",
      "description":"<GROUP_DESCRIPTION>",
      "isDefault":false,
      "applications":[ ],
      "networks":[ ],
      "vpnLocations":[ ],
      "users":[ ],
      "createdAt":"2021-03-31T17:09:19.537Z",
      "updatedAt":"2021-04-18T13:09:41.514Z",
      "id":"Ernx0tnHYw"
    }
  ],
  "page":1,
  "totalPage":26,
  "itemsTotal":26
}


        Was this article helpful?
        What's Next