Get api v1 organizations groups by organizations id

Get a list of the groups within the organization by using organization id

GET/api/v1/Organizations/{id}/groups

Get a list of the groups within the organization, by organization ID

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

 

RESPONSE INFORMATION

• Code: 200
• Description: successful
• Media type: text/plain; application/json; text/json
• Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "description": "string",
      "organizationId": "string",
      "user": "string",
      "membersCount": 0,
      "created": "2023-12-08T08:43:11.992Z",
      "updated": "2023-12-08T08:43:11.992Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Id	String	Internal id to identify the organization
Description	String	Description of the group
Organization id	String	Organization id number
User	String	Name of the user
Member count	Integer	Members within the group
Created	Datetime	Datetime when the organization was created in the system
Updated	Datetime	Datetime when the organization was last updated.

---

---

Related topics

• Get Api V1 Organizations By Id

---