result.data | object | Yes | — | Response containing list of associated user groups |
result.data.user_groups | array | Yes | — | Array of user groups Maximum items: 200. |
result.data.user_groups[].created_by | object | Yes | — | User who created this group |
result.data.user_groups[].created_by.name | string | Yes | — | Name of the creator Maximum length: 512. |
result.data.user_groups[].created_by.id | string | Yes | — | ID of the creator Maximum length: 19. |
result.data.user_groups[].modified_by | record | Yes | — | User who last modified this group |
result.data.user_groups[].modified_time | record | Yes | — | Last modification timestamp |
result.data.user_groups[].created_time | string | Yes | — | Creation timestamp Format: date-time. |
result.data.user_groups[].description | record | Yes | — | Group description |
result.data.user_groups[].id | string | Yes | — | Unique identifier for the group Maximum length: 19. |
result.data.user_groups[].name | string | Yes | — | Name of the group Maximum length: 250. |
result.data.user_groups[].sources | array | No | — | Array of sources for the user group Maximum items: 200. |
result.data.user_groups[].sources[].source | object | Yes | — | Source information |
result.data.user_groups[].sources[].source.name | string | Yes | — | Name of the source Maximum length: 250. |
result.data.user_groups[].sources[].source.id | string | Yes | — | ID of the source Maximum length: 19. |
result.data.user_groups[].sources[].type | "users" | "roles" | "territories" | "groups" | Yes | — | Type of the source Allowed: users, roles, territories, groups. |
result.data.user_groups[].sources[].subordinates | boolean | No | — | Include subordinates flag |
result.data.user_groups[].sources[].sub_territories | boolean | No | — | Include sub-territories flag |
result.data.user_groups[].sources_count | object | No | — | Count of sources by type |
result.data.user_groups[].sources_count.territories | integer | No | — | Number of territories Format: int32. |
result.data.user_groups[].sources_count.roles | integer | No | — | Number of roles Format: int32. |
result.data.user_groups[].sources_count.groups | integer | No | — | Number of groups Format: int32. |
result.data.user_groups[].sources_count.users | object | No | — | User count by status |
result.data.user_groups[].sources_count.users.inactive | integer | Yes | — | Number of inactive users Format: int32. |
result.data.user_groups[].sources_count.users.deleted | integer | Yes | — | Number of deleted users Format: int32. |
result.data.user_groups[].sources_count.users.active | integer | Yes | — | Number of active users Format: int32. |
result.data.info | object | Yes | — | Information about pagination |
result.data.info.per_page | integer | Yes | — | Number of records per page Format: int32. |
result.data.info.count | integer | Yes | — | Number of records Format: int32. |
result.data.info.page | integer | Yes | — | Current page number Format: int32. |
result.data.info.more_records | boolean | Yes | — | Indicates if there are more records available |
result.meta | object | No | — | Additional response metadata (status, paging). |