Skip to main content

Get user group

GET
/partner/v1.0/users/groups/:group_id

Retrieves the user group details.


Headers​

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

Path Parameters​

group_id string Required
The group id for the group.


Response​

200 OK.

Parameters
id string
The group id for the group.
name string
The name of the group.
description string
The description of the group.
created_at string
The created date of the group.
updated_at string
The updated date of the group.
GET /users/groups/:group_id
curl -X GET 'https://staging.api.pulsifi.me/partner/v1.0/users/groups/{group_id}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
Response
{ 
  "data": {
    "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"
  },
  "meta": null
}