Skip to main content

Get all user groups

GET
/partner/v1.0/users/groups

Retrieves the user group list.


Headers​

  • Accept : application/json
  • Content-Type : application/json
  • Authorization : Bearer {access_token}

Query Parameters​

page number Optional
Indicates which specific page of results you want to retrieve. The default value is 1.
page_size number Optional
Indicates how many items should be included in each page of results. The default value is 25.
sort_by string Optional
Comma separated sortable fields (e.g., name, +name, -name).
q string Optional
Keyword to filter with group name.


Response​

200 OK.

Parameters
total_count number
The total number of groups.
result array object
The list of groups.
Child Parameters
id string (uuid)
The group id for the group.
name string
The name of the group.
description string
The description of the group.
created_at string (UTC Date)
The created date of the group.
updated_at string (UTC Date)
The updated date of the group.
GET /users/groups
curl -X GET 'https://staging.api.pulsifi.me/partner/v1.0/users/groups?page={page}&page_size={limit}&sort_by={string}&q={string}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
Response
{
  "data": {
    "total_count": 1,
    "result":  [
      {    
        "id": "<Pulsifi Group ID>",
        "name": "<Group Name>",
        "description": "<Group Description>",
        "created_at": "2025-05-05T10:45:18.935Z",
        "updated_at": "2025-05-05T10:45:18.935Z",
        "member_count": 99,
      } 
    ]
  },
  "meta": null
}